Stripe: Sigma schemas

← Sigma operations · All schemas

Retrieve a scheduled query run — response body

Field	Type	Presence	Description and constraints
$	object	Root	If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), 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.
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data_load_time	JSON	Required within parent
data_load_time (anyOf 1)	integer	Alternative	When the query was run, Sigma contained a snapshot of your Stripe data at this time. Format: unix-time
data_load_time (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error	Model	Optional	Expand Retrieve a scheduled query run — response body — error
file	JSON	Optional
file (anyOf 1)	JSON	Alternative	The file object representing the results of the query.
file (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a file — response body
file (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: scheduled_query_run
result_available_until	JSON	Required within parent
result_available_until (anyOf 1)	integer	Alternative	Time at which the result expires and is no longer available for download. Format: unix-time
result_available_until (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sql	string	Required within parent	SQL for the query. Maximum length: 100000
status	string	Required within parent	The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. Maximum length: 5000
title	string	Required within parent	Title of the query. Maximum length: 5000

Referenced models: Create a file — response body, Retrieve a scheduled query run — response body — error

Retrieve a scheduled query run — response body — error

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Information about the run failure. Maximum length: 5000

Update an existing Sigma Query — response body

Field	Type	Presence	Description and constraints
$	object	Root	A saved query object represents a query that can be executed for a run.
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch.
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
name	string	Required within parent	The name of the query. Maximum length: 5000
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: sigma.sigma_api_query
sql	string	Required within parent	The sql statement for the query. Maximum length: 5000