Skip to main content

List the carriers of a survey

GET 

/api/v2/survey/:surveyCode/carriers

Returns the complete carriers tree of a survey in one response: the folders that group the media and the carriers they contain.

A carrier is a media vehicle measured by the survey: a TV channel, a radio station, a publication, a website, and so on. Carrier ids are the input of the media operations: the CARRIERS axes of POST /api/v2/table/{surveyCode} and POST /api/v2/reach/{surveyCode}, the carriers of POST /api/v2/survey/{surveyCode}/ranking, .../evaluation and .../response-curve, and the carriers[].id of POST /api/v2/survey/{surveyCode}/optimizations.

To load the tree level by level or to search carriers by name, use POST /api/v2/survey/{surveyCode}/tree/query with treeType: ["CARRIERS"].

Before you call it​

  • surveyCode is the code of a survey returned by GET /api/v2/users/surveys.

Response​

  • An array of root folders (type: FOLDER). Folders contain sub-folders or carriers (type: CARRIER) in items; carriers are leaves.
  • The id of a CARRIER item (for example TVCH1005D1F1) is the carrier id expected by the operations above. Folder ids identify the folder within the tree.
  • audienceModel on a carrier is the audience model the survey uses for it: STANDARD, DIGITAL_MEASUREMENT, POISSON, ITALIAN_DIARY_INTERNET or ITALIAN_DIARY. It is informative. Carriers have no subtype.
  • Properties without a value are omitted.

Behaviour​

  • The whole tree is returned: there is no pagination and no truncation.
  • Send Accept-Encoding: gzip; the response is then compressed.
  • The tree changes rarely: cache it on your side.

Errors​

StatuserrorCodeWhen
400TREE_ERR_404The survey has no carriers tree.
401E401The X-API-Key header is missing or empty.
403AE_ERR_415The survey is not available to you: not contracted, disabled, being loaded, or non-existent.
500GEN_ERR_500Unexpected error.

Request​

Responses​

The carriers tree of the survey, as an array of root folders with their descendants nested in items.