Skip to main content

Item

An item selected in a slice of a matrix (Matrix.items): a statistic, a variable with its selected category in items, or a carrier.

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.

itemsundefined[]

Categories of a variable: the ones selected in the slice. Absent on the rest of the items.

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.

Item
{
"id": "string",
"label": "string",
"type": "VARIABLES",
"subtype": "string",
"items": [
null
],
"filterTgl": "string",
"selected": true
}