Report Type List

Return a list of report types.

URI: /services/data/vXX.X/analytics/report-types

Formats: JSON

HTTP methods

MethodDescription
GETReturns a list of report types.

An array of report type folder objects. Each object contains the following fields:

PropertyTypeDescription
labelStringThe end user-facing name of the report type folder.
report-typesreport-types[]An array of report types.

report-types[]

An array of report type objects. Each object contains the following fields:

PropertyTypeDescription
describeUrlStringA URL link to the report type’s metadata.
descriptionStringOptional. A description of the report type.
isHiddenBooleanIndicates whether an administrator has hidden the report type (true) or not (false). Hidden report types don’t appear in the report builder when creating a report.
isHistoricalBooleanOptional. true for historical tracking report types. If this property is missing, the value is assumed to be false.
labelStringThe end user-facing name of the report type in the report builder.
supportsJoinedFormatBooleanSpecifies whether a report type is compatible with joined reports (true) or not (false).
typeStringThe API name of the report type.