Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

The Scheduled Query object 

Attributes

  • idstring

    Unique identifier for the object.

  • data_load_timetimestamp

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

  • filenullable object

    The file object representing the results of the query.

  • sqlstring

    SQL for the query.

  • statusstring

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

  • titlestring

    Title of the query.

More attributes

  • objectstring

  • createdtimestamp

  • errornullable object

  • livemodeboolean

  • result_available_untiltimestamp

The Scheduled Query object
{
  "object": "list",
  "url": "/v1/sigma/scheduled_query_runs",
  "has_more": false,
  "data": [
    {
      "id": "sqr_1NpIuH2eZvKYlo2CP72f3rLR",
      "object": "scheduled_query_run",
      "created": 1694472517,
      "data_load_time": 1694217600,
      "file": {
        "id": "file_1BE4yZ2eZvKYlo2C9MeXgqcB",
        "object": "file",
        "created": 1508284799,
        "expires_at": null,
        "filename": "path",
        "links": {
          "object": "list",
          "data": [],
          "has_more": false,
          "url": "/v1/file_links?file=file_1BE4yZ2eZvKYlo2C9MeXgqcB"
        },
        "purpose": "sigma_scheduled_query",
        "size": 500,
        "title": null,
        "type": "csv",
        "url": "https://files.stripe.com/v1/files/file_1BE4yZ2eZvKYlo2C9MeXgqcB/contents"
      },
      "livemode": false,
      "result_available_until": 1726012800,
      "sql": "SELECT count(*) from charges",
      "status": "completed",
      "title": "Count all charges"
    }
  ]
}

Retrieve a scheduled query run 

Retrieves the details of an scheduled query run.

Parameters

No parameters.

Returns

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

GET /v1/sigma/scheduled_query_runs/:id
curl https://api.stripe.com/v1/sigma/scheduled_query_runs/sqr_1NpIuH2eZvKYlo2CP72f3rLR \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "object": "list",
  "url": "/v1/sigma/scheduled_query_runs",
  "has_more": false,
  "data": [
    {
      "id": "sqr_1NpIuH2eZvKYlo2CP72f3rLR",
      "object": "scheduled_query_run",
      "created": 1694472517,
      "data_load_time": 1694217600,
      "file": {
        "id": "file_1BE4yZ2eZvKYlo2C9MeXgqcB",
        "object": "file",
        "created": 1508284799,
        "expires_at": null,
        "filename": "path",
        "links": {
          "object": "list",
          "data": [],
          "has_more": false,
          "url": "/v1/file_links?file=file_1BE4yZ2eZvKYlo2C9MeXgqcB"
        },
        "purpose": "sigma_scheduled_query",
        "size": 500,
        "title": null,
        "type": "csv",
        "url": "https://files.stripe.com/v1/files/file_1BE4yZ2eZvKYlo2C9MeXgqcB/contents"
      },
      "livemode": false,
      "result_available_until": 1726012800,
      "sql": "SELECT count(*) from charges",
      "status": "completed",
      "title": "Count all charges"
    }
  ]
}

List all scheduled query runs 

Returns a list of scheduled query runs.

Parameters

No parameters.

More parameters

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A paginated list of all scheduled query runs.

GET /v1/sigma/scheduled_query_runs
curl -G https://api.stripe.com/v1/sigma/scheduled_query_runs \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/sigma/scheduled_query_runs",
  "has_more": false,
  "data": [
    {
      "object": "list",
      "url": "/v1/sigma/scheduled_query_runs",
      "has_more": false,
      "data": [
        {
          "id": "sqr_1NpIuH2eZvKYlo2CP72f3rLR",
          "object": "scheduled_query_run",
          "created": 1694472517,
          "data_load_time": 1694217600,
          "file": {
            "id": "file_1BE4yZ2eZvKYlo2C9MeXgqcB",
            "object": "file",
            "created": 1508284799,
            "expires_at": null,
            "filename": "path",
            "links": {
              "object": "list",
              "data": [],
              "has_more": false,
              "url": "/v1/file_links?file=file_1BE4yZ2eZvKYlo2C9MeXgqcB"
            },
            "purpose": "sigma_scheduled_query",
            "size": 500,
            "title": null,
            "type": "csv",
            "url": "https://files.stripe.com/v1/files/file_1BE4yZ2eZvKYlo2C9MeXgqcB/contents"
          },
          "livemode": false,
          "result_available_until": 1726012800,
          "sql": "SELECT count(*) from charges",
          "status": "completed",
          "title": "Count all charges"
        }
      ]
    }
  ]
}

Query Run 

Represents an ad-hoc execution of a Sigma query via the API

Endpoints

Report Runs 

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Endpoints