POST /v1/reporting/report_runs
Creates a new object and begin running the report. (Certain report types require a live-mode API key.)
Servers
- https://api.stripe.com/
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
report_type |
String | Yes |
The ID of the report type to run, such as |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
parameters |
Object | No |
Parameters specifying how the report should be run. Different Report Types have different required and optional parameters, listed in the API Access to Reports documentation. |
parameters.timezone |
String | No |
Possible values:
|
parameters.interval_end |
Integer | No | |
parameters.payout |
String | No | |
parameters.columns[] |
Array | No | |
parameters.interval_start |
Integer | No | |
parameters.reporting_category |
String | No |
Possible values:
|
parameters.currency |
String | No | |
parameters.connected_account |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.