APapptweak
Keyword Metrics

Keyword Metrics - History

Changed on

Get historical metrics of a keyword (volume) for a given date range. If you want to have live data for keyword metrics, please see Keyword Metrics - Current <br/><br/> See also: Volume History - multi-countries extract (Recipe) <Callout icon="📘" theme="info"><b>What <code>volume</code> carries over a range</b><p><code>volume</code> returns the AppTweak Volume Estimate from August 12, 2026 onward. Earlier days keep the store-reported score, which is not rewritten, so a range spanning that date shows a step change. Request <code>search_popularity</code> for the App Store's raw, store-reported score.</p><p><code>search_popularity</code> is only available in countries where <a href="https://ads.apple.com/app-store/countries-and-regions" target="_blank"><b>Apple Ads</b></a> is available, and is rejected for <code>device=android</code>: Google Play publishes no equivalent. Use <code>volume</code> for Android keyword volume.</p><p>Android volume history starts on February 10, 2024.</p></Callout> <br/><br/> <b>Price</b> <table> <thead><tr><th>Metrics</th><th>Description</th><th>Credits/kw for 1 day</th><th>Credits/kw per extra day</th></tr></thead> <tbody> <tr><td><b>volume</b></td><td>Hash containing the AppTweak Volume Estimate of how popular the keyword is in Search, on a scale from 5 to 100, and the associated date.</td><td>10</td><td>1</td></tr> <tr><td><b>results</b></td><td>Hash containing the number of results and the associated date.</td><td>10</td><td>1</td></tr> <tr><td><b>max_reach</b></td><td>Hash containing the max reach and the associated date.</td><td>10</td><td>1</td></tr> <tr><td><b>search_popularity</b></td><td>Hash containing the App Store's raw, store-reported Search Popularity score and the associated date. A score between 5 and 100 that shows how popular a keyword is in terms of searches — the higher the number, the more popular the keyword. Only available in countries where Apple Ads is available, and not for android.</td><td>10</td><td>1</td></tr> </tbody> </table>

get/keywords/metrics/history.json

Request

  • Base URL
    https://public-api.apptweak.com/api/public/store
  • URL
    https://public-api.apptweak.com/api/public/store/keywords/metrics/history.json
  • Auth
    API key in header x-apptweak-key

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, search_popularity)

countrystring

Two-letter country code (us, gb, fr). Accepted values: <a href="https://developers.apptweak.com/reference/countries-1" target="_blank"><code>GET /api/public/apptweak/countries</code></a> with store=ios or store=android. Defaults to us.

languagestring

AppTweak language code, not always ISO: US English is us, US Spanish sp. Accepted pairs: <a href="https://developers.apptweak.com/reference/languages-1" target="_blank"><code>GET /api/public/apptweak/languages</code></a> with store=ios or store=android. Defaults to the country's <a href="https://developers.apptweak.com/reference/languages-overview#default-language" target="_blank"><b>default language</b></a>.

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

Choose a device from iphone, ipad or android. Defaults to iphone.

start_datestring date

Start date (YYYY-MM-DD). Defaults to 30 days ago.

end_datestring date

End date (YYYY-MM-DD). Defaults to yesterday.

Response

Successful response.

resultobject

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter end_date, default value 2022-01-07 was removed

    • breaking

      for the query request parameter language, default value us was removed

    • breaking

      for the query request parameter start_date, default value 2021-12-24 was removed

    • breaking

      for the query request parameter end_date, the format changed from no format to date

    • breaking

      for the query request parameter start_date, the format changed from no format to date

    • breaking

      the response property // became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response's property type changed from no type to object for status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property / from the response with the status

    • info

      api tag Keyword Metrics added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      the response's property default value 0 was removed for the status

    • info

      the response's property default value 0 was removed for the status

    • info

      the response's property default value 0 was removed for the status