Sign in

v52

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-015891,4406.1 MB

Retrieve a Report Type

Retrieves the details of a Report Type. (Certain report types require a live-mode API key.)

get/v1/reporting/report_types/{report_type}

Path parameters

report_typestring required

Query parameters

expandstring[]

Specifies which fields in the response should be expanded.

Response

Successful response.

data_available_endinteger required

Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.

data_available_startinteger required

Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.

default_columnsstring[] nullable

List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the columns parameter, this will be null.)

idstring required

The ID of the Report Type, such as balance.summary.1.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

namestring required

Human-readable name of the Report Type

object'reporting.report_type' required

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

updatedinteger required

When this Report Type was latest updated. Measured in seconds since the Unix epoch.

versioninteger required

Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.