Sigma API の概要非公開プレビュー

Sigma API についてご紹介します。

Sigma API を使用すると、プログラムでクエリを保存して実行できます。

始める

この例では、クエリをすぐに実行しています。

Command Line
curl https://api.stripe.com/v1/sigma/query_runs -X POST -d sql="SELECT * FROM balance_transactions LIMIT 10" -H "Authorization: Bearer ${SIGMA_API_KEY}"

次のようなレスポンスが返されます。返された ID を使用して、クエリ実行のステータスを確認します。

{
  "id": "qry_0RHnkR589O8KAxCGsLQqzkd0",
  "object": "sigma.sigma_query_run",
  "created": 1745593263,
  "error": null,
  "finalized_at": null,
  "livemode": true,
  "result": {
    "file": null
  },
  "sql": "SELECT * FROM balance_transactions LIMIT 10",
  "status": "running"
}

クエリの実行が完了したかどうかを判断するには、クエリを取得してステータスを確認します。

Command Line
curl https://api.stripe.com/v1/sigma/query_runs/qry_0RHnkR589O8KAxCGsLQqzkd0 -X GET -H "Authorization: Bearer ${SIGMA_API_KEY}"

クエリの実行が完了して結果が表示されると、status は succeeded になり、result.file プロパティに File ID が追加されます。

{
  "id": "qry_0RHnkR589O8KAxCGsLQqzkd0",
  "object": "sigma.sigma_query_run",
  "created": 1745593263,
  "error": null,
  "finalized_at": 1745593273,
  "livemode": true,
  "result": {
    "file": "file_0RHnkb589O8KAxCGYVDkVc5V"
  },
  "sql": "SELECT * FROM balance_transactions LIMIT 10",
  "status": "succeeded"
}

結果をダウンロードするには、File ID を使用して /v1/files/:id/contents/ を GET します。

Command Line
curl --output file_0RHnkb589O8KAxCGYVDkVc5V.csv https://files.stripe.com/v1/files/file_0RHnkb589O8KAxCGYVDkVc5V/contents -X GET -H "Authorization: Bearer ${SIGMA_API_KEY}"

結果は、--output を指定した名前のローカル CSV ファイルに含まれています。

保存済みクエリ

保存したクエリを作成、取得、更新、削除するには、/v1/sigma/saved_queries エンドポイントおよび /v1/sigma/saved_queries/:id エンドポイントで Saved Query リソースを操作します。

保存したクエリを作成するには、/v1/sigma/saved_queries に POST します。sql パラメーターには、Sigma クエリエディターと同じ構文でクエリを指定します。レスポンスには、新しいクエリの ID が含まれます。

Command Line
curl https://api.stripe.com/v1/sigma/saved_queries -X POST -d sql="SELECT * FROM balance_transactions LIMIT 10" -H "Authorization: Bearer ${SIGMA_API_KEY}"

保存したクエリを更新するには、/v1/sigma/saved_queries/:id に POST します。sql パラメーターに新しいクエリを指定して、既存のクエリを置き換えます。

Command Line
curl https://api.stripe.com/v1/sigma/saved_queries/qfl_0RHnkR589O8KAxCGsLQqzkd0 -X POST -d sql="SELECT * FROM balance_transactions WHERE created >= timestamp '2025-04-01' LIMIT 10" -H "Authorization: Bearer ${SIGMA_API_KEY}"

保存したクエリを取得するには、/v1/sigma/saved_queries/:id を GET します。

Command Line
curl https://api.stripe.com/v1/sigma/saved_queries/qfl_0RHnkR589O8KAxCGsLQqzkd0 -X GET -H "Authorization: Bearer ${SIGMA_API_KEY}"

保存したクエリを削除するには、/v1/sigma/saved_queries/:id を削除します。

Command Line
curl https://api.stripe.com/v1/sigma/saved_queries/qfl_0RHnkR589O8KAxCGsLQqzkd0 -X DELETE -H "Authorization: Bearer ${SIGMA_API_KEY}"

クエリの実行

保存したクエリを実行したり、クエリ実行のステータスを取得したりするには、/v1/sigma/query_runs エンドポイントおよび /v1/sigma/query_runs/:id エンドポイントを使用します。

また、このエンドポイントに直接渡してクエリを実行することも可能です。

注

クエリ実行リクエストに対するレスポンスには、保存したクエリではなく、クエリ実行 ID が含まれます。

保存したクエリを実行するには、/v1/sigma/query_runs に POST し、from_saved_query パラメーターに保存したクエリの ID を指定します。

Command Line
curl https://api.stripe.com/v1/sigma/query_runs -X POST -d from_saved_query="qfl_0RHnRX589O8KAxCGD5v78Gn4" -H "Authorization: Bearer ${SIGMA_API_KEY}"

クエリを直接実行するには、/v1/sigma/query_runs に POST します。sql パラメーターには、Sigma クエリエディターと同じ構文でクエリを指定します。

Command Line
curl https://api.stripe.com/v1/sigma/query_runs -X POST  -d sql="SELECT * FROM balance_transactions LIMIT 10" -H "Authorization: Bearer ${SIGMA_API_KEY}"

クエリ実行結果のダウンロード

クエリ実行が正常に作成された場合、ステータスは running になります。

{
  "id": "qry_0RHnkR589O8KAxCGsLQqzkd0",
  "object": "sigma.sigma_query_run",
  "created": 1745593263,
  "error": null,
  "finalized_at": null,
  "livemode": true,
  "result": {
    "file": null
  },
  "sql": "SELECT * FROM balance_transactions LIMIT 10",
  "status": "running"
}

クエリの実行が完了したかどうかを判断するには、クエリを取得してステータスを確認します。

Command Line
curl https://api.stripe.com/v1/sigma/query_runs/qry_0RHnkR589O8KAxCGsLQqzkd0 -X GET -H "Authorization: Bearer ${SIGMA_API_KEY}"

クエリの実行が完了して結果が表示されると、status は succeeded になり、result.file プロパティに File ID が追加されます。

{
  "id": "qry_0RHnkR589O8KAxCGsLQqzkd0",
  "object": "sigma.sigma_query_run",
  "created": 1745593263,
  "error": null,
  "finalized_at": 1745593273,
  "livemode": true,
  "result": {
    "file": "file_0RHnkb589O8KAxCGYVDkVc5V"
  },
  "sql": "SELECT * FROM balance_transactions LIMIT 10",
  "status": "succeeded"
}

結果をダウンロードするには、File ID を使用して /v1/files/:id/contents/ を GET します。

Command Line
curl --output file_0RHnkb589O8KAxCGYVDkVc5V.csv https://files.stripe.com/v1/files/file_0RHnkb589O8KAxCGYVDkVc5V/contents  -X GET -H "Authorization: Bearer ${SIGMA_API_KEY}"

結果は、--output を指定した名前のローカル CSV ファイルに含まれています。