ReachCapabilities
Reach statistics and diary edges of a survey, as needed to build POST /api/v2/reach/{surveyCode}.
statistics object
Statistics of the STATISTICS axis available in each mode, under the keys REACH_TABLE, REACH_DUPLICATION and REACH_TREND. Send their id in a STATISTICS axis of the same mode. The REACH_TREND list is the same as the REACH_TABLE one.
property name* object[]
Identifier to send in a STATISTICS axis of a Reach request. Ids are stable: a survey offers some of the ids of each mode, and an id never changes its name.
Display label, in the language of the user.
Explanation of the statistic, in the language of the user. It can be absent.
differences object
Statistics of the DIFFERENCES axis available in each mode that has one. Today only the key REACH_TREND, with the differences between survey waves. Send their id in the DIFFERENCES axis of that mode.
property name* object[]
Identifier to send in a STATISTICS axis of a Reach request. Ids are stable: a survey offers some of the ids of each mode, and an id never changes its name.
Display label, in the language of the user.
Explanation of the statistic, in the language of the user. It can be absent.
diaryEdges object[]
Diary edges of the survey. Use the name of an edge as edge in the diary edge axes and in diaryFilters.
Name of the edge. Send it as edge in the diary edge axes and in diaryFilters.
Informative. Do not send it: use name.
Informative. Do not send it: use axisType.
Display title of the edge, in the language of the user.
Axis type to use for this edge: CUSTOM_DIARY_EDGE when the edge lists values; otherwise TIME_DIARY_EDGE.
| Enum Value | Description |
|---|---|
| CUSTOM_DIARY_EDGE | The edge lists values: send their codes in a CUSTOM_DIARY_EDGE axis. |
| TIME_DIARY_EDGE | The time edge: split the day with a TIME_DIARY_EDGE axis. |
Possible values: [CUSTOM_DIARY_EDGE, TIME_DIARY_EDGE]
values object[]
Selectable values of the edge. Send their codes in a CUSTOM_DIARY_EDGE axis or in diaryFilters. Absent on the time edge.
Numeric code of the value. Send it, as a string, in diaryFilters[].values and in the items of a CUSTOM_DIARY_EDGE axis.
Display label of the value, in the language of the user.
For a group value, the codes of the individual values it groups. Absent for a single value.
time object
Time configuration. Only present on the time edge (TIME_DIARY_EDGE).
Time (HH:mm) at which the diary day of the survey starts.
allowedStepsRanges object[]
Slot sizes, in minutes, offered for time.step of a TIME_DIARY_EDGE axis.
Slot size in minutes. Use it as time.step of a TIME_DIARY_EDGE axis.
Possible values: >= 1
Display label of the slot size, in the language of the user.
Whether explicit time.ranges are offered on this edge.
filter object
Present when the edge can be used in diaryFilters; absent otherwise. An edge without filter is for breakdowns only: use it as an axis.
Display title of the filter, in the language of the user.
Display order among the diary filters.
Default selection of the filter: sending these codes, or every value of the edge, is the same as not filtering.
capabilities object
Optional features of the edge, such as whether it offers group values.
Whether the edge offers group values: values with combines, which group other values.
{
"statistics": {},
"differences": {},
"diaryEdges": [
{
"name": "string",
"attribute": "string",
"type": "string",
"title": "string",
"axisType": "CUSTOM_DIARY_EDGE",
"values": [
{
"code": 0,
"label": "string",
"combines": [
0
]
}
],
"time": {
"defaultStart": "string",
"allowedStepsRanges": [
{
"step": 0,
"label": "string"
}
],
"supportsExplicitRanges": true
},
"filter": {
"title": "string",
"position": 0,
"values": [
0
]
},
"capabilities": {
"supportsGroups": true
}
}
]
}