Skip to main content

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.

axisstring

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.

idstring

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).

labelstring

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.

oneOf
string

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 ValueDescription
VARIABLESStatistic calculated over survey variables, such as the weighted total.
REACHReach statistic of a consumption-diary survey.
MEDIAMedia planning statistic, such as GRP or cover.

Possible values: [VARIABLES, REACH, MEDIA]

subtypestring

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.

  • Array [
  • 0
    1
    2
    3
    4
    5
    6
    7
    8
    9
  • ]
  • filterTglstring

    Not returned by the v2 endpoints.

    selectedboolean

    In Matrix.items, whether the item is the selected one in its axis. Not returned by tree listings.

    AxisItem
    {
    "axis": "string",
    "variable": {
    "id": "string",
    "label": "string",
    "type": "VARIABLES",
    "subtype": "string",
    "items": [
    {}
    ],
    "filterTgl": "string",
    "selected": true
    }
    }