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

The Scheduled Query object 

Sigma
Scheduled Queries
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.

    • file.idstring

      Unique identifier for the object.

    • file.objectstring

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

    • file.createdtimestamp

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

    • file.expires_atnullable timestamp

      The file expires and isn’t available at this time in epoch seconds.

    • file.filenamenullable string

      The suitable name for saving the file to a filesystem.

    • file.linksnullable object

      A list of file links that point at this file.

      • file.links.objectstring

        String representing the object’s type. Objects of the same type share the same value. Always has the value list.

      • file.links.dataarray of objects

        Details about each object.

        • file.links.data.idstring

          Unique identifier for the object.

        • file.links.data.objectstring

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

        • file.links.data.createdtimestamp

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

        • file.links.data.expiredboolean

          Returns if the link is already expired.

        • file.links.data.expires_atnullable timestamp

          Time that the link expires.

        • file.links.data.filestringExpandable

          The file object this link points to.

        • file.links.data.livemodeboolean

          Has the value true if the object exists in live mode or the value false if the object exists in test mode.

        • file.links.data.metadataobject

          Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

        • file.links.data.urlnullable string

          The publicly accessible URL to download the file.

      • file.links.has_moreboolean

        True if this list has another page of items after this one that can be fetched.

      • file.links.urlstring

        The URL where this list can be accessed.

    • file.purposeenum

      The purpose of the uploaded file.

      Possible enum values
      account_requirement

      Additional documentation requirements that can be requested for an account.

      additional_verification

      Additional verification for custom accounts.

      business_icon

      A business icon.

      business_logo

      A business logo.

      customer_signature

      Customer signature image.

      dispute_evidence

      Evidence to submit with a dispute response.

      finance_report_run

      User-accessible copies of query results from the Reporting dataset.

      financial_account_statement

      Financial account statements.

      identity_document

      A document to verify the identity of an account owner during account provisioning.

      identity_document_downloadable

      Image of a document collected by Stripe Identity.

      Show 8 more

    • file.sizeinteger

      The size of the file object in bytes.

    • file.titlenullable string

      A suitable title for the document.

    • file.typenullable string

      The returned file type (for example, csv, pdf, jpg, or png).

    • file.urlnullable string

      Use your live secret API key to download the file from this URL.

  • 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

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

  • createdtimestamp

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

  • errornullable object

    If the query run was not successful, this field contains information about the failure.

    • error.messagestring

      Information about the run failure.

  • livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • result_available_untiltimestamp

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

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"
    }
  ]
}