APapptweak
Ad Intelligence

Paid Keywords by App

Changed on

Get an app's paid keywords, and the number of bids found for each. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>Credits/request for 1 day</th><th>Credits/request per extra day</th></tr></thead> <tbody> <tr><td><b>bids</b></td><td>list of objects, one per keyword on which an ad for the app was observed, with the day of each observation</td><td>1000</td><td>100</td></tr> </tbody> </table> <Callout icon="📘" theme="info"><b>Missing keywords?</b><p>Not seeing a keyword on which your app's ads run? One reason could be that AppTweak didn't fetch data for that keyword. You should make sure to follow the keyword for the selected device and country through our ASO tool to ensure its data is fetched daily.</p></Callout>

get/apps/keywords/bids.json

Request

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

Query parameters

appsstring required

Comma-separated list of app IDs (max 5). <a href="https://developers.apptweak.com/reference/how-to-find-app-ids" target="_blank"><b>How to find App IDs?</b></a>

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.

aggregatedboolean

true: one row per keyword with the number of times an ad was observed over the range (count), highest count first. false: one row per keyword per day an ad was observed (date). The price is the same either way; it follows the date range, not this flag. Defaults to false.

Response

Successful response.

resultobject

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter aggregated, default value false was added

    • breaking

      for the query request parameter end_date, default value was removed

    • breaking

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

    • breaking

      for the query request parameter start_date, default value 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's body type changed from no type to object for status

    • info

      api tag Ad Intelligence added

    • info

      removed subschema #1: iOS - non-aggregated subschema #2: Android - non-aggregated 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