Retrieve a Query Run

Retrieve the status of Query Run

Parameters

idstringRequired
The id of the query run to retrieve. This should be a valid id that was previously created.

Returns

Returns the specified Query Run object.

GET /v1/sigma/query_runs/:id

cURL

curl https://api.stripe.com/v1/sigma/query_runs/qfl_0R46kn589O8KAxCGtbTjfolP \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"

Response

{
  "id": "qfl_0R46kn589O8KAxCGtbTjfolP",
  "object": "sigma.sigma_api_query",
  "created": 1742329729,
  "livemode": true,
  "sql": "SELECT * FROM balance_transactions LIMIT 5",
  "name": "Select balance transactions"
}

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

POST/v1/reporting/report_runs

GET/v1/reporting/report_runs/:id

GET/v1/reporting/report_runs

Report Types

The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

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

GET/v1/reporting/report_types/:id

GET/v1/reporting/report_types

Report Runs v2

The ReportRun object represents an instance of a Report 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 the results.

Learn more about calling API v2 endpoints.

Reports v2

The Report resource represents a customizable report template that provides insights into various aspects of your Stripe integration.