ReachDiaryEdge
A diary edge of the survey: a dimension of the consumption diary (such as the day or the time of day) that a Reach table can break down by or filter on.
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.
{
"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
}
}