Retrieve a scheduled query run

Changed on

Retrieves the details of a scheduled query run.

get/v1/sigma/scheduled_query_runs/{scheduled_query_run}

Request

  • Base URL: https://api.stripe.com
  • URL: https://api.stripe.com/v1/sigma/scheduled_query_runs/{scheduled_query_run}
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Path parameters

scheduled_query_runstring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Request body application/x-www-form-urlencoded

object required

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

data_load_timeinteger required

When the query was run, Sigma contained a snapshot of your Stripe data at this time.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'scheduled_query_run' required

String representing the object's type. Objects of the same type share the same value.

result_available_untilinteger required

Time at which the result expires and is no longer available for download.

sqlstring required

SQL for the query.

statusstring required

The query's execution status, which will be completed for successful runs, and canceled, failed, or timed_out otherwise.

titlestring required

Title of the query.

Changes

  • c113b1939b8fRevision changes
    • info

      added the optional property ////// to the response with the status

  • 7b8f614372caRevision changes
    • info

      added the optional property ////////// to the response with the status

Some revisions have not been checked yet.