Contents

SearchTermPopularityQueryRequest

Request body for the search term popularity query endpoint.

Declaration

object SearchTermPopularityQueryRequest

Properties

NameTypeDescription
filters[Filter]

Filter conditions to scope results to specific countries or genres. See Filterable Fields for genre values matching App Store genre names.

sorting[Sorting]

Sort criteria. Maximum two sort fields. Default genre ASC, rankInGenre ASC.

timeRange RequiredSearchTermPopularityTimeRange

timeRange is required and specifies the date window to query. Timezone is fixed to UTC. See SearchTermPopularityTimeRange for granularity rules.

paginationRequestPagination

See RequestPagination for details. This endpoint caps pageSize at 5000.

Example

{
  "fields": [
    "rankInGenre",
    "searchPopularityInGenre",
    "searchPopularity1to100",
    "searchPopularity1to5"
  ],
  "filters": [
    {
      "field": "countryOrRegion",
      "operator": "EQUALS",
      "value": "US"
    },
    {
      "field": "genre",
      "operator": "EQUALS",
      "value": "PRODUCTIVITY_UTILITIES"
    }
  ],
  "sorting": [
    {
      "field": "rankInGenre",
      "order": "ASC"
    }
  ],
  "timeRange": {
    "start": "2025-01-05",
    "end": "2025-01-11",
    "granularity": "WEEKLY_SUN_SAT"
  },
  "pagination": {
    "offset": 0,
    "pageSize": 20
  }
}

See Also