In-App Events

Get In-App event metadata from the App Store or LiveOps metadata from Google Play

Using AppTweak API you can get In-App Event metadata that are appearing on a store listing page. AppTweak doesn't store data about events that are appearing elsewhere. You can refer to the following screenshot to see which In-App Event or LiveOps AppTweak gets data for.


AppTweak only collects In-App events or LiveOps that are appearing on an app store listing page.

Input parameters

You can pass the following query parameters: apps, country,device, start_date, end_date. The date parameters corresponds to the dates where the events are running.

All the In-App or LiveOps events running during that date range will be returning by the endpoint.

Response format

The response is a JSON organised by app id and events. In the following table you can find the fields and their equivalence with the terms used in the AppTweak tool for In-App Events on iOS or LiveOps on Android.

API fieldiOSAndroid
event-Event type
titleEvent titleTag line
subtitleShort description-
descriptionDescription (detailed view)Description
artwork_urlURL of the In-App Event imageURL of the Liveops image
event_start_dateThe start date of the event in YYYY-MM-DDThe start date of the event in YYYY-MM-DD
event_end_dateThe end date of the event as it is set-up in the App Store in YYYY-MM-DDEnd date or Estimated end date in YYYY-MM-DD
promotion_start_dateThe date when the event will start appearing on the App Store (which can be earlier than the start date
of the event)
event_start_timeUTC time in hh:mm:ss UTC time in hh:mm:ss
event_end_timeUTC time in hh:mm:ssUTC time in hh:mm:ss
promotion_start_timeUTC time in hh:mm:ss-
requirementIf anything is required in order to access the event -
e.g a subscription
video_link-URL of the Video shown in the detailed view (once you've clicked on the event card). The video is optional when creating a Promotional Content

Below you'll find a response example for an In-App Event on iOS in the US for the app HBO Max.

  "result": {
    "971265422": {
      "events": [
          "event_id": 6443959390, // Event id
          "last_seen": "2022-12-07 02:00:58 +0000", // Last time AppTweak saw the event
          "title": "Shaq", // Event title
          "subtitle": "Stream this new HBO Original on HBO Max.", // Short description
          "description": "The story of a basketball legend unlike any other, whose larger-than-life personality transcended the sport.", // Description (detailed view)
          "artwork_url": "", // Image url
          "event_start_date": "2022-11-24", // Sart date
          "event_end_date": "2022-12-07", // End date
          "promotion_start_date": "2022-11-22", // Promotion Start Data
          "event_start_time": "02:00:00", // UTC time
          "event_end_time": "05:00:00", // UTC time
          "promotion_start_time": "05:00:00", // UTC time
          "requirement": null // No requirements
  "metadata": {
    "request": {
      "path": "/api/public/store/apps/events",
      "params": {
        "device": "iphone",
        "country": "us",
        "language": "us",
        "start_date": "2022-11-24",
        "end_date": "2022-11-25",
        "apps": [
      "cost": 34,
      "max_credit_cost": 34,
      "status": 200
    "response": null