SourcesAxis
SOURCES axis: the survey waves compared in a TREND or REACH_TREND table, identified by survey code.
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.
Display label of the axis. Optional in requests; returned in responses, in the language of the user.
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
- 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
Identifier of the variable: the variable id for VAR and CUSTOM_VAR, the saved target id for TARGET_VAR. Not used for TOTAL.
Label of the variable, in the language of the user. Always returned in responses.
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]
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 Value | Description |
|---|---|
| SINGLE | Categorical variable with one answer per respondent. |
| MULTIPLE | Categorical variable with several answers per respondent. |
| NUMERIC | Numeric variable with integer values. |
| REAL | Numeric variable with decimal values. |
| FREQUENCY | Frequency variable. |
| LOGIC | Logical variable, true or false. |
| WEIGHTED | Weighted numeric variable. |
| TOTAL | Total, with no variable behind it. |
| TEXT | Free 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.
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.
Member category ids of a JOINT category. When omitted, the joint contains only id. Ignored for the other types.
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.
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]
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.
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.
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.
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.
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.
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.
id of the split VARIABLES axis this axis hangs from. Required.
Possible values: Value must match regular expression \S
categories object[]required
Categories of the split, in order. Required and non-empty.
Possible values: >= 1
Kind of category. Required: a blank value returns 400 AE_ERR_412 and an unknown one 400 AE_ERR_401.
| Enum Value | Description |
|---|---|
| SPLIT | A category of the split, matched by label against the categories of the parent variables. |
| BASE | The base category of the split. |
| TOTAL | The total category of the split. |
Possible values: [SPLIT, BASE, TOTAL]
Category label, in the language of the user. Used by SPLIT categories: it is matched against the labels of the categories of the parent axis variables.
Whether the category is hidden in the result. Omitted when false.
statistics object[]required
Statistics to calculate. Ids come from GET /api/v2/statistics?tableType=... (Reach tables: from the reach-capabilities operation). An id that is not valid for the table type is rejected by the calculation engine (T_ERR_106). In a PLANES axis several statistics can be selected, one matrix each; in any other axis at most one (AE_ERR_404).
Possible values: >= 1
Identifier of the statistic, as returned by GET /api/v2/statistics. Send it in a STATISTICS axis.
Display label, in the language of the user.
Explanation of what the statistic measures, in the language of the user.
Not returned by GET /api/v2/statistics. In table requests and responses it marks the selected statistic of an axis; in a PLANES axis several can be selected (one matrix each), in any other axis at most one.
carriers object[]required
Carriers of this axis, with ids from GET /api/v2/survey/{surveyCode}/carriers. type CARRIER (the default when omitted) is one carrier, CARRIER_JOINT is a joint of the carriers listed in ids (with an id chosen by the caller) and TOTAL_MEDIA is the aggregate of all media (its id is ignored). Any other value, FOLDER included, is treated as a single carrier.
Possible values: >= 1
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.
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.
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 Value | Description |
|---|---|
| CARRIER | One carrier (a media vehicle). It is the default when type is omitted. |
| FOLDER | Every carrier of a folder of the carriers tree. It is read in targetMedia; a CARRIERS axis reads it as a single carrier. |
| CARRIER_JOINT | A joint of the carriers listed in ids, with an id chosen by the caller; in targetMedia it counts as its members. |
| TOTAL_MEDIA | The aggregate of all the media of the survey. It is sent only in a CARRIERS axis, and its id is ignored. |
| TOTAL | The total of the carriers of a table. Responses only. |
| MEDIA_PLAN | One plan of the table. Responses only. |
| MEDIA_PLAN_TOTAL | The total of the plans of the table. Responses only. |
Possible values: [CARRIER, FOLDER, CARRIER_JOINT, TOTAL_MEDIA, TOTAL, MEDIA_PLAN, MEDIA_PLAN_TOTAL]
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.
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.
Whether this is the main carriers axis of a Reach table. It is passed to the calculation engine as is. Optional; false when omitted.
differences object[]required
Difference statistics to calculate. Only id and selected of each statistic are read.
Possible values: >= 1
Identifier of the statistic, as returned by GET /api/v2/statistics. Send it in a STATISTICS axis.
Display label, in the language of the user.
Explanation of what the statistic measures, in the language of the user.
Not returned by GET /api/v2/statistics. In table requests and responses it marks the selected statistic of an axis; in a PLANES axis several can be selected (one matrix each), in any other axis at most one.
Diary edge to break down by: the name of an entry of diaryEdges in the reach-capabilities response of the survey. Required.
Possible values: Value must match regular expression \S
Value codes of the edge to include, sent as numeric strings (diaryEdges[].values[].code of the reach-capabilities response). Required and non-empty.
Possible values: >= 1
Name of the time edge: the name of the diaryEdges entry of type TIME_DIARY_EDGE in the reach-capabilities response of the survey. Required (AE_ERR_412).
Possible values: Value must match regular expression \S
time objectrequired
How the day is split into ranges: explicit ranges, or a step between from and to. Required.
Informative: the mode is inferred from the fields sent (ranges, or step with from and to), so this value is not read.
Possible values: [byStep, explicit]
Slot length in minutes: a positive integer. Take it from time.allowedStepsRanges in the reach-capabilities response; other positive values are accepted too. The last slot is shorter when the span is not a multiple of step.
Start of the split, in HH:mm. Used with step and to. Send a valid HH:mm: a malformed value is not rejected with a 400.
End of the split, in HH:mm (24:00 is allowed). Used with step and from. When it is earlier than from, the split continues past midnight; equal values cover the whole day.
ranges object[]
Explicit slots. When not empty, they are used and step, from and to are ignored.
Start of the slot, in HH:mm.
End of the slot, in HH:mm.
mediaItems object[]
Carriers of the table, in order, with their insertions.
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.
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.
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 Value | Description |
|---|---|
| CARRIER | One carrier (a media vehicle). It is the default when type is omitted. |
| FOLDER | Every carrier of a folder of the carriers tree. It is read in targetMedia; a CARRIERS axis reads it as a single carrier. |
| CARRIER_JOINT | A joint of the carriers listed in ids, with an id chosen by the caller; in targetMedia it counts as its members. |
| TOTAL_MEDIA | The aggregate of all the media of the survey. It is sent only in a CARRIERS axis, and its id is ignored. |
| TOTAL | The total of the carriers of a table. Responses only. |
| MEDIA_PLAN | One plan of the table. Responses only. |
| MEDIA_PLAN_TOTAL | The total of the plans of the table. Responses only. |
Possible values: [CARRIER, FOLDER, CARRIER_JOINT, TOTAL_MEDIA, TOTAL, MEDIA_PLAN, MEDIA_PLAN_TOTAL]
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.
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.
mediaPlans object[]
Plans of the table, in order.
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.
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.
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 Value | Description |
|---|---|
| CARRIER | One carrier (a media vehicle). It is the default when type is omitted. |
| FOLDER | Every carrier of a folder of the carriers tree. It is read in targetMedia; a CARRIERS axis reads it as a single carrier. |
| CARRIER_JOINT | A joint of the carriers listed in ids, with an id chosen by the caller; in targetMedia it counts as its members. |
| TOTAL_MEDIA | The aggregate of all the media of the survey. It is sent only in a CARRIERS axis, and its id is ignored. |
| TOTAL | The total of the carriers of a table. Responses only. |
| MEDIA_PLAN | One plan of the table. Responses only. |
| MEDIA_PLAN_TOTAL | The total of the plans of the table. Responses only. |
Possible values: [CARRIER, FOLDER, CARRIER_JOINT, TOTAL_MEDIA, TOTAL, MEDIA_PLAN, MEDIA_PLAN_TOTAL]
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.
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.
sources object[]required
Survey waves to compare, in order. Each id is a survey code from GET /api/v2/users/surveys. A TREND or REACH_TREND table also needs a DIFFERENCES axis.
Possible values: >= 1
Code of the survey wave, as returned in code by GET /api/v2/users/surveys.
Display label of the survey wave, in the language of the user. Ignored in requests.
Wave shown when the SOURCES axis is in PLANES: at most one wave of that axis can be selected (more return 400 AE_ERR_404), and without any the first one is shown. In ROWS or COLUMNS every wave is calculated and shown.
Weeks of the wave, each with the id (YYYY/WW) returned by GET /api/v2/survey/{surveyCode}/weeks-and-weights for this survey. A wave of a survey with weeks that comes without them, or with a week the survey does not have, is left out with a TR_ERR_107 diagnostic. Ignored for a survey without weeks. An empty list is the same as not sending it.
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.
Identifier of the weighting.
Name of the weighting, as the survey defines it. It is not translated.
Universe of the weighting. It can be missing.
Whether it is the default weighting of the survey, the one used when a table is sent without a weighting.
{
"sources": [
{
"id": "string",
"label": "string",
"selected": true,
"weeks": [
"string"
],
"weight": {
"id": "string",
"label": "string",
"universe": 0,
"isDefault": true
}
}
],
"id": "string",
"label": "string",
"axisType": "VARIABLES"
}