MOmorningconsult
Data

Get Syndicated Survey Timeseries Data

Deprecated. This endpoint will be sunset on January 15, 2027. Use the /responses resource API for updated question response retrieval. Get respondents data for a particular question. Every question_id included in the request body --- whether as the question of interest or within the audience parameter --- must be from the same country.

post/surveys/syndicated/timeseries

Request

Request body

min_datestring date

Minimum date of data returned in YYYY-MM-DD format. The date provided is inclusive. Omitting this field will return the earliest available trend data.

max_datestring date

Maximum date of data returned in YYYY-MM-DD format. The date provided is inclusive. Omitting this field will return the most recent available trend data.

question_idstring uuid required

The unique identifier for a question. The question itself must have <em>fewer than 100 predefined responses.</em> You can get the number of responses for a question from the <a class="text-break" href="#GET-getSurveysSyndicatedQuestionsByID">/surveys/syndicated/questions/{question_id}</a> endpoint.

Example request

{
  "min_date": "2018-01-31",
  "max_date": "2018-01-31",
  "audience": {
    "question_id": "29433f2b-3ea0-4214-ae8f-9ad09549c082",
    "response_ids": [
      "1",
      "2"
    ]
  },
  "aggregation": {
    "interval": "month"
  },
  "question_id": "a7ee637c-e5d1-4cf8-b484-8eb372f22941"
}

Response

Trend Data

Example response

{
  "data": [
    {
      "date": "2017-11-23",
      "responses": [
        {
          "percent": 42.953760405946554,
          "id": "1",
          "label": "Very Favorable"
        },
        {
          "percent": 57.046239594053446,
          "id": "2",
          "label": "Somewhat Favorable"
        }
      ],
      "total_n": 1570
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.