v1

latestOpenAPI 3.1.02026-07-24450694.7 KB

Keyword Metrics - History

Get historical metrics of a keyword (volume) for a given date range. If you want to have live data for keyword metrics, please see <a href="https://developers.apptweak.com/reference/keyword-metrics-current" target="_blank">Keyword Metrics - Current</a>

get/keywords/metrics/history.json

Query parameters

keywordsstring required

Comma separated list of keywords. Max 5 keywords are allowed.

metricsstring required

Comma separated list of metrics. (volume, max_reach, results)

countrystring

Two letter <a href="https://apptweak.readme.io/reference/country-codes" target="_blank">country code</a>. Default: us

languagestring

Two letter <a href="https://developers.apptweak.com/reference/languages" target="_blank">language code</a>. Default: AppTweak <a href="https://developers.apptweak.com/reference/languages-overview#default-language" target="_blank">default language</a> of the country.

device'iphone' | 'ipad' | 'android'

Choose a device from android, iphone or ipad. Default: iphone

start_datestring

Start date of the period in format YYYY-MM-DD Default: 30 days ago

end_datestring

End date of the period in format YYYY-MM-DD Default: yesterday

Response

200

Example response

{
  "result": {
    "karaoke": {
      "volume": [
        {
          "date": "2021-12-24",
          "value": 54
        }
      ],
      "results": [
        {
          "date": "2021-12-24",
          "value": 1728
        }
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/store/keywords/metrics/history.json",
      "params": {
        "device": "iphone",
        "country": "us",
        "language": "us",
        "start_date": "2021-12-24",
        "end_date": "2022-01-07",
        "keywords": [
          "karaoke"
        ],
        "metrics": [
          "volume"
        ]
      },
      "cost": 145,
      "max_credit_cost": 145,
      "status": 200
    }
  }
}