AxisItem
Coordinate of a slice: an axis and the item selected in it. The items list of a matrix identifies the slice the matrix belongs to.
Axis the selected item belongs to: its id in Matrix.items (the id of the axis in dimensions), and its label in the combinations of a saved tabulation.
variable object
Item selected in the axis. Despite its name it can be any axis item: a statistic (type VARIABLES, REACH or MEDIA), a variable (type VAR, CUSTOM_VAR, TARGET_VAR or TOTAL) with its selected category in items, or another axis item.
Identifier of the item: a statistic id, a variable id, a category id or a carrier id (the id of the carrier in its axis).
Display label, in the language of the user.
type object
Kind of item. A statistic: its family, StatisticFamily (VARIABLES, REACH or MEDIA). A variable: its type, VariableKind (VAR, CUSTOM_VAR, TARGET_VAR or TOTAL); inside its items, the type of each category, CategoryKind. Omitted for a carrier, and for a kind the API does not describe.
- StatisticFamily
- VariableKind
- CategoryKind
Family of a statistic: the kind of calculation it belongs to. It is the type of a statistic selected in Matrix.items. Values are case-sensitive.
| Enum Value | Description |
|---|---|
| VARIABLES | Statistic calculated over survey variables, such as the weighted total. |
| REACH | Reach statistic of a consumption-diary survey. |
| MEDIA | Media planning statistic, such as GRP or cover. |
Possible values: [VARIABLES, REACH, MEDIA]
Kind of variable of a VARIABLES axis. Values are case-sensitive.
| Enum Value | Description |
|---|---|
| VAR | Survey variable. |
| CUSTOM_VAR | User variable saved in the workspace. |
| TARGET_VAR | Target, a saved one by id or a TGL expression in filterTgl, used as a variable. |
| TOTAL | Total, with no variable behind it. |
Possible values: [VAR, CUSTOM_VAR, TARGET_VAR, TOTAL]
Kind of category of a variable. Values are case-sensitive, except JOINT.
| Enum Value | Description |
|---|---|
| CATEGORY | A category of a survey variable. |
| CUSTOM_CAT | A category of a user variable. |
| JOINT | The union of the categories listed in ids. |
| BASE | The base category: responses return it with the id BASE. |
Possible values: [CATEGORY, CUSTOM_CAT, JOINT, BASE]
For a variable, how it is measured: a VariableSubtype such as SINGLE, MULTIPLE, NUMERIC, REAL, LOGIC, TEXT or FREQUENCY; it can be absent. Absent on statistics, carriers and categories.
items object[]
Categories of a variable: the ones selected in the slice. Absent on the rest of the items.
Not returned by the v2 endpoints.
In Matrix.items, whether the item is the selected one in its axis. Not returned by tree listings.
{
"axis": "string",
"variable": {
"id": "string",
"label": "string",
"type": "VARIABLES",
"subtype": "string",
"items": [
{}
],
"filterTgl": "string",
"selected": true
}
}