# reporting.report\_run

From **Stripe API**.

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](https://stripe.com/docs/reporting/statements/api).

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](https://stripe.com/docs/keys#test-live-modes).

- Type: `object`

## Properties

### `created`

- Required: true
- Type: `integer`
- Format: `unix-time`

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

### `error`

- Required: false
- Type: `string`
- Nullable: true
- maxLength: `5000`

If something should go wrong during the run, a message about the failure (populated when
 `status=failed`).

### `id`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `livemode`

- Required: true
- Type: `boolean`

`true` if the report is run on live mode data and `false` if it is run on test mode data.

### `object`

- Required: true
- Type: `string`
- Allowed values: `"reporting.report_run"`

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

### `parameters`

- Required: true
- Type: `object`

### `report_type`

- Required: true
- Type: `string`
- maxLength: `5000`

The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `"balance.summary.1"`.

### `result`

- Required: false
- Nullable: true

The file object representing the result of the report run (populated when
 `status=succeeded`).

### `status`

- Required: true
- Type: `string`
- maxLength: `5000`

Status of this report run. This will be `pending` when the run is initially created.
 When the run finishes, this will be set to `succeeded` and the `result` field will be populated.
 Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.

### `succeeded_at`

- Required: false
- Type: `integer`
- Format: `unix-time`
- Nullable: true

Timestamp at which this run successfully finished (populated when
 `status=succeeded`). Measured in seconds since the Unix epoch.

## JSON Schema

```json
{"description":"The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).","properties":{"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"error":{"description":"If something should go wrong during the run, a message about the failure (populated when\n `status=failed`).","maxLength":5000,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"livemode":{"description":"`true` if the report is run on live mode data and `false` if it is run on test mode data.","type":"boolean"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["reporting.report_run"],"type":"string"},"parameters":{"$ref":"#/components/schemas/financial_reporting_finance_report_run_run_parameters"},"report_type":{"description":"The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`.","maxLength":5000,"type":"string"},"result":{"anyOf":[{"$ref":"#/components/schemas/file"}],"description":"The file object representing the result of the report run (populated when\n `status=succeeded`).","nullable":true},"status":{"description":"Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated.","maxLength":5000,"type":"string"},"succeeded_at":{"description":"Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch.","format":"unix-time","nullable":true,"type":"integer"}},"required":["created","id","livemode","object","parameters","report_type","status"],"title":"reporting_report_run","type":"object","x-expandableFields":["parameters","result"],"x-resourceId":"reporting.report_run"}
```