Sign in

v1

latestOpenAPI 3.1.02026-07-24450694.7 KB

In-App Events List

Returns all the In-App events or Promotional Content of an app on the selected date range.

get/apps/events

Query parameters

appsstring required

Comma separated list of app IDs. Max 5 apps are allowed. <br/> <a href="https://developers.apptweak.com/reference/how-to-find-app-ids" target="_blank">How to find App IDs?</a>

countrystring

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

languagestring

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

device'iphone' | 'android'

The device you want to fetch the top chart for: iphone or android

start_datestring date

Start date of the period in format YYYY-MM-DD<br/><b>Default:</b> 30 days ago

end_datestring date

End date of the period in format YYYY-MM-DD<br/><b>Default:</b> yesterday

Response

200

OR

Example response

{
  "result": {
    "545519333": {
      "events": [
        {
          "event_id": 6443741640,
          "last_seen": "2022-11-11 06:55:09 +0000",
          "title": "The Rings of Power, S1 Finale",
          "subtitle": "Discover the legend that forged the rings",
          "description": "Beginning in a time of peace, we follow a cast of characters as they confront the re-emergence of evil to Middle-earth",
          "artwork_url": "https://is5-ssl.mzstatic.com/image/thumb/TPQqSVn0EeVPfuLXRpRmcQ/3840x2160bb.jpg",
          "event_start_date": "2022-10-14",
          "event_end_date": "2022-11-11",
          "promotion_start_date": "2022-10-08",
          "event_start_time": "04:00:00",
          "event_end_time": "07:30:00",
          "promotion_start_time": "19:00:00"
        }
      ]
    }
  },
  "metadata": {
    "request": {
      "path": "/api/public/store/apps/events",
      "params": {
        "device": "iphone",
        "country": "us",
        "language": "us",
        "start_date": "2022-11-07",
        "end_date": "2022-12-07",
        "apps": [
          "545519333"
        ]
      },
      "cost": 121,
      "max_credit_cost": 121,
      "status": 200
    }
  }
}