RankingAxis
The axis of a dimension of a ranking or evaluation result. axisType selects the list it carries: CARRIERS (carriers: the rows of a ranking), MEDIA (mediaItems: the rows of an evaluation) or STATISTICS (statistics: the columns).
Identifier of the axis. It is an opaque string: do not read the kind of axis from it, use axisType.
Label of the axis, when it has one.
Kind of axis: CARRIERS for the rows of a ranking, MEDIA for the rows of an evaluation and STATISTICS for the columns of both.
| Enum Value | Description |
|---|---|
| VARIABLES | Survey variables, user variables or targets. |
| CATEGORIES | Categories of a split VARIABLES axis. |
| STATISTICS | Statistics to calculate. |
| CARRIERS | Media carriers. |
| SOURCES | Survey waves compared in a TREND table. |
| DIFFERENCES | Difference statistics of a TREND table. |
| CUSTOM_DIARY_EDGE | Values of a diary edge (Reach tables). |
| TIME_DIARY_EDGE | Time ranges of the time edge (Reach tables). |
| MEDIA | Carriers with their insertions. Responses only. |
| MEDIA_PLANS | Media plans. Responses only. |
Possible values: [VARIABLES, CATEGORIES, STATISTICS, CARRIERS, SOURCES, DIFFERENCES, CUSTOM_DIARY_EDGE, TIME_DIARY_EDGE, MEDIA, MEDIA_PLANS]
carriers object[]
Rows of a ranking, in order. With hierarchy, folder rows (type FOLDER) appear above their carriers.
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.
mediaItems object[]
Rows of an evaluation, in order, grouped by plan: a plan row (type MEDIA_PLAN) followed by the rows of its carriers. The plan row holds the figures of the plan as a whole: there is no separate total row. insertions holds a single value: the insertions of that plan, or of that carrier in that plan.
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.
statistics object[]
Columns, in order: the statistics of the result.
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.
{
"id": "string",
"label": "string",
"axisType": "VARIABLES",
"carriers": [
{
"id": "string",
"label": "string",
"type": "CARRIER",
"ids": [
"string"
],
"insertions": [
0
]
}
],
"mediaItems": [
{
"id": "string",
"label": "string",
"type": "CARRIER",
"ids": [
"string"
],
"insertions": [
0
]
}
],
"statistics": [
{
"id": "string",
"label": "string",
"description": "string",
"selected": true
}
]
}