ReportColumnDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A column a report returns.
Values
Fields
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
field
required |
string | The key the column's value is stored under in each row. Stable once published.
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.
| ||||||||||||||||
label
required |
string | The column's display label.
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.
| ||||||||||||||||
fieldType
required |
ReportColumnFieldType ReportColumnFieldType | The type of the column's 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.
| ||||||||||||||||
format
required |
string | A display format hint, for example `C` for currency or `d` for a short date, when the
report provides one. Values in rows are never pre-formatted.
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.
| ||||||||||||||||
isVisible
required |
boolean | Whether the column is shown by default.
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.
| ||||||||||||||||
aggregates
required |
array of ColumnAggregateType array of ColumnAggregateType | The totals the report shows for this column, when it shows any.
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.
|
This model has no documented fields.