APapptweak
In-App Events

In-App Events List

Changed on

Returns all the In-App events or Promotional Content of an app on the selected date range. <br/><br/> <b>Price</b> <table> <thead><tr><th>Datapoint</th><th>Description</th><th>Credits/app for 1 day</th><th>Credits/app per extra day</th></tr></thead> <tbody> <tr><td><b>events</b></td><td>List of events objects containing all the metadata of an In-App Event.</td><td>30</td><td>3</td></tr> </tbody> </table>

get/apps/events

Request

  • Base URL
    https://public-api.apptweak.com/api/public/store
  • URL
    https://public-api.apptweak.com/api/public/store/apps/events
  • 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.

Response

Successful response.

resultobject

Changes

  • a4af4000f1e3Revision changes
    • breaking

      for the query request parameter device, default value was changed from android to iphone

    • breaking

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

    • breaking

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

    • breaking

      for the query request parameter start_date, default value 2022-12-01 was removed

    • breaking

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

    • info

      api tag In-App Events added

    • info

      added the new enum value ipad to the query request parameter device

    • 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