GetReportColumnsResponse

statusstring

Possible values: [OK, FAIL, ERROR]

codestringnullable

ResultCode enum name (e.g. SUCCESS, NOT_FOUND, RATE_LIMIT_EXCEEDED)

messagestringnullable

Error message, present when status is FAIL or ERROR.

messagesstring[]nullable

In rare, specific cases, additional error messages.

data object

identityIdstring

Identifier of the organization (entityId) whose report columns these are, echoed from the request path.

columns object[]

The columns available for the requested reportType, each described by name, type, role, and primitive.

Array [

namestring

Display name of the column; pass this exact value to reference the column when running a report (as an output column, totals dimension, or sort key).

typestring

The column's semantic field type; a finer-grained classification than primitive.

rolestring

Classifies the column as a groupable attribute or an aggregatable value, determining whether it can be used as a totals dimension or a summed measure.

Possible values: [dimension, measure]

primitivestring

The underlying primitive data type of the column's values, for client-side parsing and formatting.

Possible values: [string, number, date, bool]

]

requestIdstringnullable

GetReportColumnsResponse

{
  "status": "OK",
  "code": "string",
  "message": "string",
  "messages": [
    "string"
  ],
  "data": {
    "identityId": "string",
    "columns": [
      {
        "name": "string",
        "type": "string",
        "role": "dimension",
        "primitive": "string"
      }
    ]
  },
  "requestId": "string"
}