Report

One asynchronous report generation run.

Runs are created pending; generation happens asynchronously.

created_at
Type: stringFormat: date-time
required

When the run was requested.
id
Type: stringFormat: uuid
required

The report run's ID.
report_parameters
nullable
required

The parameters this run covers, after defaults were applied. The shape depends on report_type. Null when the run has no parameters.
Parameters for a seller_financial_report run.
report_type
const:
seller_financial_report
required

The type of report these parameters describe.

end_date
Type: stringFormat: date-timenullable

Include only transactions completed before this time. Defaults to one week after start_date, or to the current hour when neither end is given.

start_date
Type: stringFormat: date-timenullable

Include only transactions completed at or after this time. Defaults to one week before end_date.
report_type
Type: enum
required

The type of report this run generates.
values
- seller_financial_report
- analytics_overview_report
- analytics_livestreams_report
report_url
Type: stringnullable
required

URL of the generated report file. Null until the run is completed.
status
Type: enum
required

The status of the run.

values
pendingin_progresscompletedfailedcancelled
updated_at
Type: stringFormat: date-time
required

When the run was last updated.