Skip to main content

CatalogItem

A node of a listing: a folder, a variable, a category, a carrier, a user variable, a category of a user variable or a target, with its children in items. Properties without a value are omitted.

idstring

Identifier of the node. Use variable ids in VARIABLES axes, category ids in categories, target ids as TARGET_VAR ids and carrier ids in carriers. Folders of user variables and targets have no id.

labelstring

Display label, in the language of the user.

typeTreeNodeType (string)

Kind of node. The set can grow, so do not fail on a value you do not know.

Enum ValueDescription
FOLDERGrouping node.
VARSurvey variable.
CATEGORYCategory of a survey variable.
CARRIERCarrier (media vehicle): a leaf of the carriers tree.
CUSTOM_VARUser variable.
CUSTOM_CATCategory of a user variable.
TARGET_VARTarget (a saved audience).

Possible values: [FOLDER, VAR, CATEGORY, CARRIER, CUSTOM_VAR, CUSTOM_CAT, TARGET_VAR]

subtypeNodeSubtype (string)

For variables, user variables and targets, how they are measured; it can be absent. Absent on folders, categories and carriers.

Enum ValueDescription
SINGLECategorical variable with one answer per respondent.
MULTIPLECategorical variable with several answers per respondent.
NUMERICNumeric variable with integer values.
REALNumeric variable with decimal values.
LOGICLogical variable, true or false. Every target is logical.
TEXTFree text. Surveys return it, but it cannot be tabulated.
FREQUENCYFrequency variable.

Possible values: [SINGLE, MULTIPLE, NUMERIC, REAL, LOGIC, TEXT, FREQUENCY]

audienceModelAudienceModel (string)

Carriers only: the audience model the survey uses for the carrier. Informative.

Enum ValueDescription
STANDARDStandard audience model of the survey.
DIGITAL_MEASUREMENTDigital media whose audience comes from an external digital measurement source.
POISSONAudience estimated with a Poisson model.
ITALIAN_DIARY_INTERNETDiary-based audience model of Italian surveys, for internet carriers.
ITALIAN_DIARYDiary-based audience model of Italian surveys.

Possible values: [STANDARD, DIGITAL_MEASUREMENT, POISSON, ITALIAN_DIARY_INTERNET, ITALIAN_DIARY]

itemsundefined[]

Children of the node: the content of a folder, or the categories of a variable. Absent on leaves.

CatalogItem
{
"id": "string",
"label": "string",
"type": "FOLDER",
"subtype": "SINGLE",
"audienceModel": "STANDARD",
"items": [
null
]
}