Présentation de l'API SigmaVersion bêta privée

En savoir plus sur l'API Sigma.

L’API Sigma vous permet d’enregistrer et d’exécuter des requêtes de manière programmatique.

Démarrer

Tout d’abord, créez une clé API limitée pour l’API Sigma.

Cet exemple exécute immédiatement une requête :

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

La réponse se présente comme suit : Utilisez l’ID renvoyé pour vérifier l’état de l’exécution de la requête.

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

Pour savoir si une exécution de requête est terminée, récupérez-la et vérifiez son état :

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

Si l’exécution de la requête est terminée et que les résultats sont disponibles, son status est succeeded et sa propriété result.file contient un ID File :

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

Pour télécharger les résultats, utilisez l’ID du File pour obtenir /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}"

Un fichier CSV local portant le nom spécifié à l’aide de --output contient les résultats.

Requêtes enregistrées

Pour créer, récupérer, mettre à jour ou supprimer une requête enregistrée, utilisez la ressource de requête enregistrée à l’aide des endpoints /v1/sigma/saved_queries et /v1/sigma/saved_queries/:id.

Pour créer une requête enregistrée, utilisez un POST dans /v1/sigma/saved_queries. Dans le paramètre sql, fournissez une requête en utilisant la même syntaxe que dans l’éditeur de requêtes Sigma. La réponse inclut l’ID de la nouvelle requête.

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

Pour mettre à jour une requête enregistrée, utilisez un POST dans /v1/sigma/saved_queries/:id. Dans le paramètre sql, fournissez une nouvelle requête pour remplacer la requête existante.

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

Pour récupérer une requête enregistrée, obtenez /v1/sigma/saved_queries/:id.

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

Pour supprimer une requête enregistrée, supprimez /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}"

Exécution de la requête

Pour exécuter une requête enregistrée ou récupérer l’état d’une exécution de requête, utilisez les endpoints /v1/sigma/query_runs et /v1/sigma/query_runs/:id.

Vous pouvez également exécuter une requête en la transmettant directement à cet endpoint.

Remarque

Les réponses aux requêtes d’exécution de requête contiennent l’ID de l’exécution de la requête, et non la requête enregistrée.

Pour exécuter une requête enregistrée, utilisez un POST dans /v1/sigma/query_runs et fournissez l’ID de la requête enregistrée dans le paramètre from_saved_query.

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

Pour exécuter directement une requête, utilisez un POST dans /v1/sigma/query_runs. Dans le paramètre sql, fournissez une requête en utilisant la même syntaxe que dans l’éditeur de requêtes 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}"

Télécharger les résultats de l’exécution de la requête

L’état d’une requête créée avec succès est 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"
}

Pour savoir si une exécution de requête est terminée, récupérez-la et vérifiez son état :

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

Si l’exécution de la requête est terminée et que les résultats sont disponibles, son status est succeeded et sa propriété result.file contient un ID File :

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

Pour télécharger les résultats, utilisez l’ID du File pour obtenir /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}"

Un fichier CSV local portant le nom spécifié à l’aide de --output contient les résultats.