Scheduled Queries

If you have scheduled a Sigma query, you’ll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

Was this section helpful? Yes No

Retrieve a scheduled query run

GET / v1 / sigma / scheduled_query_runs /:id

List all scheduled query runs

GET / v1 / sigma / scheduled_query_runs

The Scheduled Query object

Attributes

id string Unique identifier for the object.
data _ load _ time timestamp When the query was run, Sigma contained a snapshot of your Stripe data at this time.
file nullable object The file object representing the results of the query.
sql string SQL for the query.
status string The query’s execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.
title string Title of the query.

More attributes

object string, value is "scheduled_query_run"
created timestamp
error nullable object
livemode boolean
result _ available _ until timestamp

The Scheduled Query object

Retrieve a scheduled query run

GET / v1 / sigma / scheduled_query_runs /:id

Retrieves the details of an scheduled query run.

Parameters

No parameters.

Returns

Returns the scheduled query run object if a valid identifier was provided.

Response