Skip to main content

Survey

A survey the user can query: its code, name and dates.

codestring

Code of the survey. Use it as {surveyCode} in the survey operations.

descriptionstring

Name of the survey to show. Under /api/v2 it is the caller's alias for the survey (their own, or else the default one) and the catalog name when there is no alias. It is not unique and can change: identify surveys by code. The catalog name is in originalDescription.

originalDescriptionstring

Catalog name of the survey, without any alias. Use description to show the survey and this field to classify or search it. Only returned by the operations under /api/v2.

creationDatestring<date-time>

Creation date and time of the survey, ISO 8601 with a UTC offset. It can be an empty string when it is not known.

updatedDatestring<date-time>

Date and time of the last update of the survey, ISO 8601 with a UTC offset. It can be an empty string when it is not known.

availableReachboolean

Whether the survey supports Reach tables (it is built on a consumption diary). Only returned by GET /api/v2/users/surveys.

weights object[]

Weightings of the survey, in the platform's order. The default one has isDefault: true. Empty when the survey has none. Only returned by GET /api/v2/users/surveys.

  • Array [
  • 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.

  • ]
  • Survey
    {
    "code": "string",
    "description": "string",
    "originalDescription": "string",
    "creationDate": "2024-07-29T15:51:28.071Z",
    "updatedDate": "2024-07-29T15:51:28.071Z",
    "availableReach": true,
    "weights": [
    {
    "id": "string",
    "label": "string",
    "universe": 0,
    "isDefault": true
    }
    ]
    }