APapptweak
Keyword Live Search

Keyword Live Search - History

Changed on

Returns historical app results of a search for a given keyword. <br/><br/> For each day in the requested period, this query will return the search result if AppTweak made a search on that date for that keyword. <br/><br/> Please see the Current section if you want to perform a live search for given keywords. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoints</th><th>Description</th><th>Credits for 1 day</th><th>Credits per extra day</th></tr></thead> <tbody> <tr><td><b>-</b></td><td>List of app IDs that rank on that keyword. The list starts with the app that ranks first for the keyword.</td><td>50</td><td>5</td></tr> </tbody> </table> <Callout icon="📘" theme="info"><b>Note that the default selected period is 30 days; however you can provide your own date range in order to extend/shorten the targeted period.</b></Callout>

get/keywords/search-results/history.json

Request

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

Query parameters

keywordstring required

The keyword to search for. Only one keyword is allowed.

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.

Example response

{
  "result": [
    {
      "value": [
        377889715
      ]
    }
  ]
}

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter country, default value was changed from in to us

    • breaking

      for the query request parameter end_date, default value 2021-11-15 was removed

    • breaking

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

    • breaking

      for the query request parameter start_date, default value 2021-11-01 was removed

    • breaking

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

    • info

      api tag Keyword Live Search added

    • info

      removed subschema #1: iOS subschema #2: Android from the response body oneOf list for the response status

    • 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

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status