Übersicht über die Sigma APIPrivate Vorschau

Erfahren Sie mehr über die Sigma API.

Mit der Sigma API können Sie Abfragen programmgesteuert speichern und ausführen.

Loslegen

Erstellen Sie zuerst einen eingeschränkten API-Schlüssel für die Sigma API.

In diesem Beispiel wird sofort eine Abfrage ausgeführt:

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}"

Die Antwort könnte folgendermaßen aussehen. Verwenden Sie die zurückgegebene ID, um den Status der Abfrageausführung zu überprüfen.

{
  "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"
}

Um festzustellen, ob eine Abfrageausführung abgeschlossen ist, rufen Sie sie ab und überprüfen Sie ihren Status:

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

Wenn die Abfrageausführung abgeschlossen ist und Ergebnisse verfügbar sind, lautet ihr status succeeded und ihre Eigenschaft result.file enthält eine 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"
}

Um die Ergebnisse herunterzuladen, verwenden Sie die File-ID für GET /v1/files/:id/contents/:

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

Eine lokale CSV-Datei mit dem Namen, den Sie mit --output angegeben haben, enthält die Ergebnisse.

Gespeicherte Anfragen

Um eine gespeicherte Abfrage zu erstellen, abzurufen, zu aktualisieren oder zu löschen, interagieren Sie mit der gespeicherten Abfrageressource mithilfe der Endpoints /v1/sigma/saved_queries und /v1/sigma/saved_queries/:id.

Um eine gespeicherte Abfrage zu erstellen, führen Sie einen POST-Befehl an /v1/sigma/saved_queries durch. Geben Sie im Parameter sql eine Abfrage mit derselben Syntax wie im Sigma-Abfrage-Editor an. Die Antwort enthält die ID der neuen Abfrage.

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}"

Um eine gespeicherte Abfrage zu aktualisieren, führen Sie einen POST-Befehl an /v1/sigma/saved_queries/:id aus. Geben Sie im Parameter sql eine neue Abfrage an, um die vorhandene zu ersetzen.

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}"

Um eine gespeicherte Abfrage abzurufen, führen Sie GET /v1/sigma/saved_queries/:id aus.

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

Um eine gespeicherte Abfrage zu löschen, LÖSCHEN Sie /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}"

Abfrage wird ausgeführt

Verwenden Sie die Endpoints /v1/sigma/query_runs und /v1/sigma/query_runs/:id, um eine gespeicherte Abfrage auszuführen oder den Status einer Abfrageausführung abzurufen.

Sie können eine Abfrage auch ausführen, indem Sie sie direkt an diesen Endpoint übergeben.

Notiz

Antworten auf Anfragen zur Abfrageausführung enthalten die ID der Abfrageausführung, nicht die gespeicherte Abfrage.

Um eine gespeicherte Abfrage auszuführen, führen Sie einen POST an /v1/sigma/query_runs durch und geben Sie die ID der gespeicherten Abfrage im Parameter from_saved_query an.

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}"

Um eine Abfrage direkt auszuführen, senden Sie einen POST an /v1/sigma/query_runs. Geben Sie im Parameter sql eine Abfrage mit derselben Syntax wie im Sigma-Abfrage-Editor an.

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}"

Ergebnisse der Abfrageausführung herunterladen

Eine erfolgreich erstellte Abfrageausführung hat den Status 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"
}

Um festzustellen, ob eine Abfrageausführung abgeschlossen ist, rufen Sie sie ab und überprüfen Sie ihren Status:

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

Wenn die Abfrageausführung abgeschlossen ist und Ergebnisse verfügbar sind, lautet ihr status succeeded und ihre Eigenschaft result.file enthält eine 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"
}

Um die Ergebnisse herunterzuladen, verwenden Sie die File-ID für GET /v1/files/:id/contents/:

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

Eine lokale CSV-Datei mit dem Namen, den Sie mit --output angegeben haben, enthält die Ergebnisse.