ReportCatalogItemDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A report the caller can run.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||
|---|---|---|---|---|---|---|
reportId
required |
string | The report id, for example `transactions.report.Summary`. Stable: an id is never renamed
or reused.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
displayName
required |
string | The report's display name.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
description
required |
string | What the report shows, when the report describes itself.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
module
required |
string | The area of the platform the report belongs to, for example `Transactions`.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
exportFormats
required |
array of ReportFileFormat array of ReportFileFormat | The file formats the report can be exported in.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||
supportsMerchantFilter
required |
boolean | Whether a run can be narrowed to a single merchant with `merchantId`. A run of a report
that cannot be narrowed is refused when it names a merchant.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.