Data

Get Scores for Timeseries Data

Get score data for a particular score against any data source you have access to. The score_id must be valid in the specified data_source_id and country_code. Every question_id included in the audience body must also be from the same country_code.

The min_date and max_date range is bounded to 10 years. When both are omitted, the range defaults to the last 10 years. If only one is provided, the request is rejected.

post/scores

Request

Request body

data_source_idstring uuid required

The unique identifier for a data source.

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.

score_idstring uuid required

The unique identifier for a score.

country_codestring required

Two letter ISO 3166-1 alpha-2 country code. This can be used in the country_code query parameter of multiple endpoints to limit results to the specific country.

entity_idstring

Entity ID to run the score against if an Entity ID is required.

component_idsstring[]

The component IDs to use when computing the score. Required for scores whose metadata lists components (for example "Price Surprise" and "Unavailability"). See /scores to discover the components available for a score.

Example request

{
  "data_source_id": "00de2081-e013-411d-823c-cd483283e38d",
  "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"
  },
  "score_id": "7fa7d4a5-8b79-462c-b9ae-03a0431cb5e5",
  "country_code": "us",
  "entity_id": "avon",
  "component_ids": [
    "home_appliances"
  ]
}

Response

Score Data

Example response

{
  "scores": [
    {
      "date": "2025-11-14",
      "score": {
        "value": 43
      },
      "total_n": 1550
    }
  ]
}

Changes

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