Sample - Stripe API
GET/v1/sigma/scheduled_query_runs/{scheduled_query_run}

Retrieve a scheduled query run

Retrieves the details of a scheduled query run. Use the run identifier to inspect the SQL, execution status, data snapshot time, and result expiration time. The response may also include the file containing the query results.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
scheduled_query_runstringrequired
The unique identifier of the scheduled query run to retrieve; must not exceed 5,000 characters.
expandarray<string>optional
Fields to expand in the response; each field name must not exceed 5,000 characters.

2 status codes
200Returns the scheduled query run with its identifier, SQL, title, execution status, data load time, result availability deadline, and any result file or error details.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
data_load_timeintegerrequired
When the query was run, Sigma contained a snapshot of your Stripe data at this time.
errorobjectoptional
fileobjectoptional
The file object representing the results of the query.
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:scheduled_query_run
result_available_untilintegerrequired
Time at which the result expires and is no longer available for download.
sqlstringrequired
SQL for the query.
statusstringrequired
The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
titlestringrequired
Title of the query.
defaultError response.
errorobjectrequired

Error handling

scheduled_query_run must be a string of no more than 5,000 characters identifying the scheduled query run. Each value in expand must also be a string of no more than 5,000 characters when supplied.