Reports
Represents report run objects, each of which is an instance of a report type generated with specific run parameters, including run status, result file details, and reporting parameters. Uses the V1 endpoint.
View-Specific Information
Note: This report requires a live-mode API key, which can be set using the LiveAPIKey connection property. This view is not accessible without specifying the LiveAPIKey.
SELECT
The driver uses the Stripe API to filter the results by the following columns and operators while the rest of the filter is executed client-side within the driver.
| Column | Supported Operators |
| Id | =, IN |
| Created | =, >, >=, <, <= |
You can select from Reports with the following queries:
SELECT * FROM Reports WHERE Id = 'frr_1I480mATXQzBWNrlYQRaLQ9x'
SELECT * FROM Reports WHERE Id IN ('frr_1I14hXATXQzBWNrlGP5pSxd9', 'frr_1I14h9ATXQzBWNrlEG32QcPH')
SELECT * FROM Reports WHERE Created <= '2024-01-18 11:52:34.0'
Columns
| Name | Type | References | Description |
| Id [KEY] | String | The unique identifier for the report run. | |
| Created | Datetime | The time at which the report run was created, measured in seconds since the Unix epoch. | |
| Error | String | A message describing the failure if an error occurs during the run. This value is populated when the status is failed. | |
| Livemode | Boolean | Indicates whether the object exists in live mode. This value is always true because reports can only be run on live-mode data. | |
| Object | String | The string representing the object's type. Objects of the same type share the same value. | |
| ParametersIntervalEnd | Datetime | The ending timestamp of the data to be included in the report run. This value is exclusive. | |
| ParametersIntervalStart | Datetime | The starting timestamp of the data to be included in the report run. | |
| ParametersColumns | String | The set of output columns requested for inclusion in the report run. | |
| ParametersConnectedAccount | String | The connected account Id by which to filter the report run. | |
| ParametersCurrency | String | The currency of the objects to be included in the report run. | |
| ParametersPayout | String |
Payouts.Id | The payout Id by which to filter the report run. |
| ParametersReportingCategory | String | The category of balance transactions to be included in the report run. | |
| ParametersTimezone | String | The output timezone for all timestamps in the report. Defaults to Etc/UTC. | |
| Report_type | String | The Id of the report type to run, such as balance.summary.1.
The allowed values are balance_change_from_activity.itemized.1, balance_change_from_activity.itemized.2, balance_change_from_activity.itemized.3, balance_change_from_activity.summary.1, payouts.itemized.1, payouts.itemized.2, payouts.itemized.3, payouts.summary.1, balance.summary.1, ending_balance_reconciliation.itemized.1, ending_balance_reconciliation.itemized.2, ending_balance_reconciliation.itemized.3, ending_balance_reconciliation.summary.1, ending_balance_reconciliation.itemized.4, payout_reconciliation.by_id.itemized.1, payout_reconciliation.by_id.itemized.2, payout_reconciliation.by_id.itemized.3, payout_reconciliation.by_id.itemized.4, payout_reconciliation.by_id.summary.1, payout_reconciliation.itemized.1, payout_reconciliation.itemized.2, payout_reconciliation.itemized.3, payout_reconciliation.itemized.4, payout_reconciliation.summary.1, payout_reconciliation.itemized.5. | |
| ResultCreated | Datetime | The time at which the result file was created, measured in seconds since the Unix epoch. | |
| ResultExpiresAt | Datetime | The time at which the file expires and is no longer available, measured in seconds since the Unix epoch. | |
| ResultFilename | String | A filename for the result file, suitable for saving to a filesystem. | |
| ResultId | String | The unique identifier for the result file. | |
| ResultLinksHas_more | Boolean | Indicates whether this list has another page of items after this one that can be fetched. | |
| ResultLinksObject | String | The string representing the object's type. Objects of the same type share the same value. Always has the value list. | |
| ResultLinksUrl | String | The URL where this list can be accessed. | |
| ResultObject | String | The string representing the object's type. Objects of the same type share the same value. | |
| ResultPurpose | String | The purpose of the uploaded file.
The allowed values are account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, identity_document, pci_document, tax_document_user_upload. | |
| ResultSize | Integer | The size of the result file, measured in bytes. | |
| ResultTitle | String | A user-friendly title for the document. | |
| ResultType | String | The type of the file returned, such as csv, pdf, jpg, or png. | |
| ResultUrl | String | The URL from which the file can be downloaded using your live secret API key. | |
| Status | String | The status of this report run. The value is pending when the run is initially created. When the run finishes, the value is set to succeeded and the result field is populated. If an error occurs, the value is set to failed and the error field is populated. | |
| Succeeded_at | Timestamp | The timestamp at which this run successfully finished, measured in seconds since the Unix epoch. This value is populated when the status is succeeded. | |
| ResultLinksDataAggregate | String | The details about each object in the result links. |