GET
/
reports
/
{report_id}

This endpoint requires the reports.read scope.

Authorizations

​
Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
report_id
string
required

The unique ID for a report.

Response

200 - application/json

A report record.

​
type
enum<string>

The type of this resource. Is always report.

Available options:
report
​
id
string

The unique identifier for this report.

​
merchant_account_id
string

The unique ID for a merchant account.

​
name
string

The name of this report.

Maximum length: 100
​
creator_id
string | null

The unique identifier for the creator of this report.

​
creator_display_name
string | null

The name of the creator of this report.

Maximum length: 1000
​
creator_type
enum<string> | null

The type of the creator of this report.

Available options:
user,
private_key
​
created_at
string

The date and time this report was created in our system.

​
updated_at
string

The date and time this report was last updated.

​
next_execution_at
string | null

The date and time this report will next be executed, provided that schedule_enabled is true. This value is null if this is a one-off report.

​
description
string | null

The description of this report.

Maximum length: 1000
​
schedule
enum<string>

Specifies the schedule of this report.

If this is a one-off report, this value is once.

If this is a recurring report, this value is set to the frequency by which the report will be executed. For example, a monthly schedule means that this report will be periodically executed at the start of each month.

Note that a weekly schedule means that the report is executed at the start of every Monday.

Available options:
daily,
monthly,
once,
weekly
​
schedule_enabled
boolean

Indicates whether this report's scheduling is enabled. This value can only be set to true if this is a recurring report.

When this value is set to true, this report will be executed at the next_execution_at date and time.

When this value is set to false, future executions of this report are paused until this value is set to true again.

​
schedule_timezone
string

The time zone in which the next execution will be scheduled. This value is used to calculate this report's next_execution_at value and is only relevant if this is a recurring report. This time zone is also used to calculate the timestamp range for reports that use date-time placeholders. Date-time placeholders are dynamic timestamps that change with every report execution.

​
spec
object

The specifications of this report.

​
latest_execution
object

Details of the latest execution of this report.

Was this page helpful?

List reportsNew report