New report
Creates a new report.
This endpoint requires the reports.write scope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
A request to create a report.
The name of the report.
The description of the report.
Specifies the schedule of the report.
If this is a one-off report, set this value to once.
If this is a recurring report, this value should be set to the
frequency by which the report will be executed. For example, a
monthly schedule means that the report will be periodically
executed at the start of each month.
Note that a weekly schedule means that the report will be
executed at the start of every Monday.
daily, monthly, once, weekly Indicates whether the report's scheduling is enabled. This value
can only be set to true if this is a recurring report.
If this value is set to true, the report will be executed at
the next_execution_at date and time.
If this is a recurring report and this value is set to false,
executions of the report will not occur until this value is set
to true.
If this value is not provided, schedule_enabled will
automatically be set to false if schedule is once and set to
true otherwise.
The time zone in which the report's executions will be scheduled.
This value is used to compute the report's next_execution_at
value and is only relevant when 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.
This value must be set to the time zone's name as presented in
the IANA time zone database. For example, to schedule reports in
the time zone of New York, set this value to America/New_York.
The specifications of the report.
Response
A report record.
The type of this resource. Is always report.
report The unique identifier for this report.
The unique ID for a merchant account.
The name of this report.
The unique identifier for the creator of this report.
The name of the creator of this report.
The type of the creator of this report.
user, private_key The date and time this report was created in our system.
The date and time this report was last updated.
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.
The description of this report.
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.
daily, monthly, once, weekly 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.
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.
The specifications of this report.
Details of the latest execution of this report.
Was this page helpful?