Skip to main content
POST
C#
This endpoint requires the reports.write scope.

Authorizations

Authorization
string
header
required

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

Headers

x-gr4vy-merchant-account-id
string

The ID of the merchant account to use for this request.

Example:

"default"

Body

application/json
name
string
required

The name of the report.

Required string length: 1 - 100
Example:

"Monthly Transaction Report"

schedule
string
required

The schedule for the report.

Example:

"daily"

schedule_enabled
boolean
required

Whether the report schedule is enabled.

Example:

true

spec
Spec · object
required

The report specification.

description
string | null

A description of the report.

Required string length: 1 - 1000
Example:

"Monthly transaction summary for May 2024."

schedule_timezone
string
default:Etc/UTC

The timezone for the report schedule.

Example:

"UTC"

Response

Successful Response

id
string<uuid>
required

The unique ID for the report.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

merchant_account_id
string
required

The merchant account ID this report belongs to.

Example:

"merchant-account-12345"

name
string
required

The name of the report.

Required string length: 1 - 100
Example:

"Monthly Transaction Report"

created_at
string<date-time>
required

The date this report was created at.

Example:

"2024-05-30T12:34:56.000Z"

updated_at
string<date-time>
required

The date this report was last updated.

Example:

"2024-05-30T13:00:00.000Z"

schedule
string
required

The schedule for the report.

Example:

"daily"

schedule_enabled
boolean
required

Whether the report schedule is enabled.

Example:

true

schedule_timezone
string
required

The timezone for the report schedule.

Example:

"UTC"

spec
ReportSpec · object
required

The report specification.

type
string
default:report

Always report.

Allowed value: "report"
Example:

"report"

creator_id
string<uuid> | null

The ID of the user who created the report.

Example:

"d290f1ee-6c54-4b01-90e6-d701748f0851"

creator_display_name
string | null

The display name of the report creator.

Required string length: 1 - 1000
Example:

"Jane Doe"

creator_type
string | null

The type of the report creator.

Example:

"user"

next_execution_at
string<date-time> | null

The next scheduled execution time for the report.

Example:

"2024-06-01T00:00:00.000Z"

description
string | null

A description of the report.

Required string length: 1 - 1000
Example:

"Monthly transaction summary for May 2024."

latest_execution
ReportExecutionSummary · object | null

The latest execution summary for the report.