Skip to main content

WorkspaceElement

A workspace element in a reusable form. For tables it contains a table request that can be sent to POST /api/v2/table/{surveyCode}; for targets, the target definition. USER_VAR elements carry metadata only.

idstring

Identifier of the element. Use it as {elementId} in the element operations.

namestring

Name of the element, as saved in the workspace.

typeWorkspaceElementType (string)

Kind of element. USER_VAR elements carry metadata only.

Enum ValueDescription
TABULATIONSaved tabulation, including trend tables.
REACH_TABLESaved Reach table.
TARGETSaved target (audience definition).
USER_VARUser-defined variable.

Possible values: [TABULATION, REACH_TABLE, TARGET, USER_VAR]

surveyCodestring

Survey currently active in the workspace; the request was built against it. It is not necessarily the survey the element was saved with.

creationDatestring<date-time>

Creation date and time of the element, ISO 8601 with a UTC offset.

updateDatestring<date-time>

Date and time of the last update of the element, ISO 8601 with a UTC offset.

table object

Present for TABULATION and REACH_TABLE: the saved table, always as a table request whatever its tableType (REACH_TREND included), ready to send unchanged to POST /api/v2/table/{surveyCode} with the surveyCode of the element, and for a Reach table also to POST /api/v2/reach/{surveyCode}. It includes the saved target and, when it was applied, the targetBase: with id if it was saved by id, and with filterTgl when there is a TGL expression or the saved definition can be expressed as one. A Reach table includes its targetMedia and diaryFilters when they were saved. weeks and weight are the effective ones of a TABULATION or REACH_TABLE; a TREND or REACH_TREND carries them in each survey wave of its SOURCES axis. A part that cannot be returned as it was saved is listed in notReproducible.

dimensions object[]required

ROWS, COLUMNS and/or PLANES, each with at least one axis. Required: otherwise 400 AE_ERR_413. A STATISTICS axis is required too.

  • Array [
  • idDimensionId (string)

    Which dimension it is. Send it in upper case.

    Enum ValueDescription
    ROWSItems listed down the table: the first index of table.
    COLUMNSItems listed across the table: the second index of table.
    PLANESItems that select the slice: one matrix for each selected item.

    Possible values: [ROWS, COLUMNS, PLANES]

    axis object[]required

    Axes of the dimension. Required, with at least one axis: an absent or empty list returns 400 AE_ERR_413.

    Possible values: >= 1

  • Array [
  • idstring

    Identifier of the axis. Optional: when omitted, the API assigns the lowest positive integer not already used ("1", "2", ...). Keep it unique within the request: CATEGORIES axes reference it in parentId, and responses use it in matrixList[].items[].axis. In responses, the axes of type CUSTOM_DIARY_EDGE and TIME_DIARY_EDGE return the edge name as id.

    labelstring

    Display label of the axis. Optional in requests; returned in responses, in the language of the user.

    axisType AxisKind (string)required

    Kind of axis; it selects the schema of the object. MEDIA and MEDIA_PLANS appear only in responses.

    Possible values: [VARIABLES, CATEGORIES, STATISTICS, CARRIERS, SOURCES, DIFFERENCES, CUSTOM_DIARY_EDGE, TIME_DIARY_EDGE, MEDIA, MEDIA_PLANS]

    variables object[]required

    Variables of this axis. Required and non-empty. Each variable needs a type: VAR (survey variable), CUSTOM_VAR (user variable), TARGET_VAR (a saved target or a TGL expression used as a variable) or TOTAL. Take ids from GET /api/v2/survey/{surveyCode}/variables, from the user variables of the workspace and from its targets. Omit categories to use all the categories of a categorical variable. selected marks the variable that fixes the slice in a PLANES axis: in PLANES several can be selected (one matrix each), in any other axis more than one returns 400 AE_ERR_404. VAR and CUSTOM_VAR need subtype and id (a VAR with subtype TOTAL needs no id); CUSTOM_VAR accepts the subtypes SINGLE, MULTIPLE, NUMERIC, REAL and FREQUENCY. subtype is ignored for TARGET_VAR and TOTAL. TARGET_VAR takes id (saved target) or filterTgl (TGL expression). A blank id or filterTgl counts as absent; if both are sent the TGL is used and id is ignored. A variable that cannot be converted is rejected with 400: AE_ERR_412 when a required subtype, id or filterTgl is missing and AE_ERR_416 for an unsupported combination (subtype TEXT in a VAR or CUSTOM_VAR, CUSTOM_VAR with LOGIC, TOTAL or WEIGHTED, or tgl or hidden: true in a category that is not a CUSTOM_CAT of a CUSTOM_VAR with SINGLE or MULTIPLE). Both errors locate the axis, dimension, variable (id or position), field and, when there is one, the offending value. The API does not check the subtype of a CUSTOM_VAR against the variable's definition and uses the declared one as is: send the subtype the variable actually has. In responses, a TARGET_VAR calculated from a TGL expression includes filterTgl (v1 never returns it), so the variable can be sent back unchanged.

    Possible values: >= 1

  • Array [
  • idstring

    Identifier of the variable: the variable id for VAR and CUSTOM_VAR, the saved target id for TARGET_VAR. Not used for TOTAL.

    labelstring

    Label of the variable, in the language of the user. Always returned in responses.

    typeVariableKind (string)

    Kind of variable of a VARIABLES axis. Values are case-sensitive.

    Enum ValueDescription
    VARSurvey variable.
    CUSTOM_VARUser variable saved in the workspace.
    TARGET_VARTarget, a saved one by id or a TGL expression in filterTgl, used as a variable.
    TOTALTotal, with no variable behind it.

    Possible values: [VAR, CUSTOM_VAR, TARGET_VAR, TOTAL]

    subtypeVariableSubtype (string)

    How the variable is measured. Required for VAR and CUSTOM_VAR; ignored for TARGET_VAR and TOTAL. An unknown value returns 400 AE_ERR_401.

    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.
    FREQUENCYFrequency variable.
    LOGICLogical variable, true or false.
    WEIGHTEDWeighted numeric variable.
    TOTALTotal, with no variable behind it.
    TEXTFree text. Surveys return it, but it cannot be tabulated: sending it returns AE_ERR_416.

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

    categories object[]

    Categories to calculate, for a categorical variable. Omit it to use all of them.

  • Array [
  • idstring

    Code of the category within its variable. For a JOINT, an id chosen by the caller for the joint. Responses return the base category with id BASE.

    idsstring[]

    Member category ids of a JOINT category. When omitted, the joint contains only id. Ignored for the other types.

    labelstring

    Category label, in the language of the user. Required when the variable is in a split axis (split: true), because split categories are matched by label. Always returned in responses.

    typeCategoryKind (string)required

    Kind of category of a variable. Values are case-sensitive, except JOINT.

    Enum ValueDescription
    CATEGORYA category of a survey variable.
    CUSTOM_CATA category of a user variable.
    JOINTThe union of the categories listed in ids.
    BASEThe base category: responses return it with the id BASE.

    Possible values: [CATEGORY, CUSTOM_CAT, JOINT, BASE]

    selectedboolean

    Marks the category that fixes the slice when its variable is in a PLANES axis. In PLANES, several categories can be selected (one matrix each); in any other axis, more than one returns 400 AE_ERR_404.

    tglstring

    TGL condition of a CUSTOM_CAT category of a user variable (CUSTOM_VAR, subtype SINGLE or MULTIPLE). GET /api/v2/workspace/{workspaceId}/element/{elementId} returns it with resolve=TGL. Send it back unchanged: when every CUSTOM_CAT category of the variable has one, the calculation uses them and does not look the variable up by id. A tgl anywhere else returns 400 AE_ERR_416.

    hiddenboolean

    Marks a CUSTOM_CAT category that is not shown as a row or column but is needed by a JOINT of the same variable. Returned only as true and only with tgl (see resolve in GET /api/v2/workspace/{workspaceId}/element/{elementId}). Send it back unchanged. Accepted only on a CUSTOM_CAT category of a CUSTOM_VAR with subtype SINGLE or MULTIPLE; anywhere else true returns 400 AE_ERR_416.

  • ]
  • filterTglstring

    TGL expression of a TARGET_VAR defined inline. Responses return it for a target calculated from an expression, so the variable can be sent back unchanged.

    selectedboolean

    Whether this variable is the selected one in its axis. Used to pick the slice in the PLANES dimension. Only one variable per axis can be marked as selected outside PLANES; sending more than one in such an axis results in a 400 Bad Request.

  • ]
  • splitboolean

    Whether the axis is split. When true, a CATEGORIES axis that references this axis through parentId must be present, normally in the opposite dimension (the API does not check it): its categories split every variable of this axis. Omitted when false.

  • ]
  • ]
  • tableTypeTableRequestKind (string)

    Calculation to run, TABULATION by default. Each kind needs the application module of its kind (see TableRequestKind); for the Reach kinds, see also POST /api/v2/reach/{surveyCode}. An unknown value returns 400 AE_ERR_401. BREAKDOWN_SUPPORTS is a deprecated name of BREAKDOWN_CARRIERS: it still works, use the new one.

    Enum ValueDescription
    TABULATIONCross-tabulation of survey variables (Tabulation module).
    TRENDEvolution of the figures across survey waves (Study module).
    BREAKDOWN_CARRIERSAudience breakdown by carrier (Study module).
    DUPLICATIONSDuplication between carriers (Study module).
    REACH_TABLEReach and time statistics of the carriers of a diary survey (Reach module).
    REACH_DUPLICATIONAudience overlap between the carriers of a diary survey (Reach module).
    REACH_TRENDReach and time statistics compared across survey waves (Reach module).

    Possible values: [TABULATION, TREND, BREAKDOWN_CARRIERS, DUPLICATIONS, REACH_TABLE, REACH_DUPLICATION, REACH_TREND]

    Default value: TABULATION
    extraParams object

    Advanced calculation switches, passed through to the calculation engine. The documented keys are showBases and, in a TREND or REACH_TREND, trendCategoriesMode. An invalid showBases returns 400 AE_ERR_400, and an invalid trendCategoriesMode 400 TR_ERR_106. Any other key is not part of the contract: it can change or stop working without notice.

    showBasesboolean

    Adds the base categories to the calculated table.

    Default value: false
    property name*any

    Advanced calculation switches, passed through to the calculation engine. The documented keys are showBases and, in a TREND or REACH_TREND, trendCategoriesMode. An invalid showBases returns 400 AE_ERR_400, and an invalid trendCategoriesMode 400 TR_ERR_106. Any other key is not part of the contract: it can change or stop working without notice.

    target object

    Filter applied to the whole table: a saved target id (from the targets of the workspace) or a TGL expression in filterTgl. When both are sent, filterTgl is used; the other fields are ignored. An object with neither returns 400 AE_ERR_405.

    idstring

    Identifier of the saved target, as returned by GET /api/v2/workspace/{workspaceId}/survey/{surveyCode}/targets.

    labelstring

    Display name of the target. Ignored when the target is sent in a request.

    filterTglstring

    TGL expression that defines the audience. In responses it is omitted when the target has no definition that can be expressed in TGL. In requests, send it to define the audience inline.

    creationDatestring<date-time>

    Creation date and time of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    updatedDatestring<date-time>

    Date and time of the last update of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    workspaceIdstring

    Id of the workspace that owns the target. Returned only when the target is looked up across workspaces; omitted otherwise. Ignored in requests.

    targetBase object

    Population base: fixes the reference universe of the percentages, for any tableType. It is identified by id (a saved target) or by filterTgl (an inline TGL expression); with both, filterTgl wins, and an object with neither returns 400 AE_ERR_405. Without it, the percentages are calculated over the whole universe of the survey.

    idstring

    Identifier of the saved target, as returned by GET /api/v2/workspace/{workspaceId}/survey/{surveyCode}/targets.

    labelstring

    Display name of the target. Ignored when the target is sent in a request.

    filterTglstring

    TGL expression that defines the audience. In responses it is omitted when the target has no definition that can be expressed in TGL. In requests, send it to define the audience inline.

    creationDatestring<date-time>

    Creation date and time of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    updatedDatestring<date-time>

    Date and time of the last update of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    workspaceIdstring

    Id of the workspace that owns the target. Returned only when the target is looked up across workspaces; omitted otherwise. Ignored in requests.

    dataTypeCellDataType (string)

    Format of the matrix cells, NUMBER by default. An invalid value returns 400 AE_ERR_401. Ignored by POST /api/v2/table/{surveyCode}/html.

    Enum ValueDescription
    NUMBERRaw number (the default).
    STRINGFormatted text.
    FORMATTED_CELLObject with the raw value and the formatted text.

    Possible values: [NUMBER, STRING, FORMATTED_CELL]

    Default value: NUMBER
    localestring

    Locale (BCP-47, for example en-GB) of the formatted values. It changes only the regional number format, not the language of the labels. Defaults to the locale of the user. Ignored by the HTML operation.

    decimalsinteger<int32>

    Number of decimals of the formatted values, for all statistics. It does not change the raw number. A negative value returns 400 AE_ERR_400. Defaults to the settings of the user and the statistic. Ignored by the HTML operation.

    Possible values: >= 0

    weeksstring[]

    Weeks of the table, each with the id (YYYY/WW) returned by GET /api/v2/survey/{surveyCode}/weeks-and-weights. Only with tableType TABULATION or REACH_TABLE; with any other kind, 400 AE_ERR_400 (a TREND or REACH_TREND takes them in each wave of its SOURCES axis). A week the survey does not have, or any week in a survey without weeks, returns 400 AE_ERR_400. Without it, or with an empty list, the first week of the survey is used. In a REACH_TABLE they are validated but do not change the Reach figures.

    weight object

    A weighting of a survey, as returned by GET /api/v2/survey/{surveyCode}/weeks-and-weights and in the weights of each survey of GET /api/v2/users/surveys. It can be sent as it is returned: only id is read, and it is required (400 AE_ERR_412 without it); label, universe and isDefault are ignored.

    idstringrequired

    Identifier of the weighting.

    labelstring

    Name of the weighting, as the survey defines it. It is not translated.

    universeinteger<int32>

    Universe of the weighting. It can be missing.

    isDefaultboolean

    Whether it is the default weighting of the survey, the one used when a table is sent without a weighting.

    targetMedia object[]

    The set of media that counts as 100% in share statistics: individual carriers (type omitted or CARRIER), folders (FOLDER, as returned by the carriers endpoint) and joints (CARRIER_JOINT with its member ids, counted as their members). Any other type is read as a single carrier. Without it, shares are calculated over all the media of the survey. Only with a Reach tableType (REACH_TABLE, REACH_DUPLICATION or REACH_TREND); with any other kind, 400 AE_ERR_400. An empty list is the same as not sending it.

  • Array [
  • idstring

    Identifier of the carrier or folder, as returned by the carriers tree. For a CARRIER_JOINT, an id chosen by the caller for the joint, echoed in the response. Ignored for TOTAL_MEDIA.

    labelstring

    Display label, in the language of the user. Optional in requests; for TOTAL_MEDIA it sets the label of the aggregate. Always returned in responses.

    typeCarrierType (string)

    Kind of carrier. In requests: CARRIER (the default when omitted) is one carrier; FOLDER is every carrier of a folder (targetMedia only); CARRIER_JOINT is a joint of the carriers listed in ids; TOTAL_MEDIA is the aggregate of all media (CARRIERS axis only). The meaning depends on the context: in a CARRIERS axis any value other than CARRIER_JOINT and TOTAL_MEDIA is a single carrier; targetMedia reads FOLDER as a folder and flattens a joint into its members, and any other value is a single carrier. Responses can also return TOTAL, MEDIA_PLAN and MEDIA_PLAN_TOTAL; the field is omitted for a kind the API does not describe.

    Enum ValueDescription
    CARRIEROne carrier (a media vehicle). It is the default when type is omitted.
    FOLDEREvery carrier of a folder of the carriers tree. It is read in targetMedia; a CARRIERS axis reads it as a single carrier.
    CARRIER_JOINTA joint of the carriers listed in ids, with an id chosen by the caller; in targetMedia it counts as its members.
    TOTAL_MEDIAThe aggregate of all the media of the survey. It is sent only in a CARRIERS axis, and its id is ignored.
    TOTALThe total of the carriers of a table. Responses only.
    MEDIA_PLANOne plan of the table. Responses only.
    MEDIA_PLAN_TOTALThe total of the plans of the table. Responses only.

    Possible values: [CARRIER, FOLDER, CARRIER_JOINT, TOTAL_MEDIA, TOTAL, MEDIA_PLAN, MEDIA_PLAN_TOTAL]

    idsstring[]

    Member carrier ids of a CARRIER_JOINT: at least 2, plus a caller-assigned id for the joint, which is echoed back in the response. Ignored for the other types.

    insertionsinteger<int32>[]

    Insertions of the carrier in a calculated study table (a MEDIA axis): a single value, the insertions of that row in its plan. Ignored in requests.

  • ]
  • diaryFilters object[]

    Restrict the whole calculation to some values of the diary edges that have a filter in the reach-capabilities response. Only with a Reach tableType, as targetMedia; with any other kind, 400 AE_ERR_400. An empty list is the same as not sending it.

  • Array [
  • edgestringrequired

    name of a diary edge that has a filter in the reach-capabilities response of the survey. Required.

    valuesstring[]required

    Codes of the edge values to keep, as strings (diaryEdges[].values[].code of the reach-capabilities response). Required.

  • ]
  • notReproducible object[]

    Parts of table that cannot be returned as they were saved, with the reason. Omitted when there are none. A target or targetBase listed here comes with its label only: sending it back unchanged returns 400 AE_ERR_405, so define it again.

  • Array [
  • fieldstring

    Part of table affected: target or targetBase, which come with their label only, or diaryEdge, for the diary edge axes of dimensions that left out a grouped item.

    Possible values: [target, targetBase, diaryEdge]

    reasonNotReproducibleReason (string)

    Why it cannot be returned as it was saved.

    Enum ValueDescription
    NEGATIONThe whole definition is negated, or it negates a numeric condition. A group or a category negated with NOT is expressed in filterTgl.
    WEIGHTA box or a reference carries a weight.
    NESTEDIt has nested sets or references that cannot be expanded.
    EMPTYThe definition has no conditions.
    OTHERAny other reason, or no reason was reported.
    GROUPED_ITEMOnly with field diaryEdge: an item of a diary edge axis grouped several values, and it was left out of the axis.
    TOTAL_ITEMOnly with field diaryEdge: the total item of a diary edge or time axis cannot be requested, so the figures come without that row or column.

    Possible values: [NEGATION, WEIGHT, NESTED, EMPTY, OTHER, GROUPED_ITEM, TOTAL_ITEM]

  • ]
  • target object

    Present for TARGET: id, label, filterTgl and, when available, its dates and workspaceId.

    idstring

    Identifier of the saved target, as returned by GET /api/v2/workspace/{workspaceId}/survey/{surveyCode}/targets.

    labelstring

    Display name of the target. Ignored when the target is sent in a request.

    filterTglstring

    TGL expression that defines the audience. In responses it is omitted when the target has no definition that can be expressed in TGL. In requests, send it to define the audience inline.

    creationDatestring<date-time>

    Creation date and time of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    updatedDatestring<date-time>

    Date and time of the last update of the target, ISO 8601 with a UTC offset. Omitted when not available. Ignored in requests.

    workspaceIdstring

    Id of the workspace that owns the target. Returned only when the target is looked up across workspaces; omitted otherwise. Ignored in requests.

    WorkspaceElement
    {
    "id": "string",
    "name": "string",
    "type": "TABULATION",
    "surveyCode": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "updateDate": "2024-07-29T15:51:28.071Z",
    "table": {
    "dimensions": [
    {
    "id": "ROWS",
    "axis": [
    {
    "id": "string",
    "label": "string",
    "axisType": "VARIABLES"
    }
    ]
    }
    ],
    "tableType": "TABULATION",
    "extraParams": {
    "showBases": false
    },
    "target": {
    "id": "string",
    "label": "string",
    "filterTgl": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "updatedDate": "2024-07-29T15:51:28.071Z",
    "workspaceId": "string"
    },
    "targetBase": {
    "id": "string",
    "label": "string",
    "filterTgl": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "updatedDate": "2024-07-29T15:51:28.071Z",
    "workspaceId": "string"
    },
    "dataType": "NUMBER",
    "locale": "string",
    "decimals": 0,
    "weeks": [
    "string"
    ],
    "weight": {
    "id": "string",
    "label": "string",
    "universe": 0,
    "isDefault": true
    },
    "targetMedia": [
    {
    "id": "string",
    "label": "string",
    "type": "CARRIER",
    "ids": [
    "string"
    ],
    "insertions": [
    0
    ]
    }
    ],
    "diaryFilters": [
    {
    "edge": "string",
    "values": [
    "string"
    ]
    }
    ]
    },
    "notReproducible": [
    {
    "field": "target",
    "reason": "NEGATION"
    }
    ],
    "target": {
    "id": "string",
    "label": "string",
    "filterTgl": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "updatedDate": "2024-07-29T15:51:28.071Z",
    "workspaceId": "string"
    }
    }