{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store & Google Play Rating Drop Alerts - Slack/Discord",
    "description": "Get a Slack, Discord or webhook alert when your app's rating drops, 1-star reviews spike or a new version tanks. Watches App Store, Google Play and Steam, compares you with competitors and remembers state between scheduled runs. No login, no API key.",
    "version": "2.0",
    "x-build-id": "g9YgdWrhuBhKCcIC3"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/that_red_bird~app-review-alerts/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-that_red_bird-app-review-alerts",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/that_red_bird~app-review-alerts/runs": {
      "post": {
        "operationId": "runs-sync-that_red_bird-app-review-alerts",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/that_red_bird~app-review-alerts/run-sync": {
      "post": {
        "operationId": "run-sync-that_red_bird-app-review-alerts",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "apps": {
            "title": "Your apps",
            "type": "array",
            "description": "Apps to watch: App Store URLs or ids (id310633997), Google Play URLs or package names (com.whatsapp), Steam URLs or appids (440). Mix stores freely. To be explicit use objects like {\"app\":\"440\",\"store\":\"steam\"}.",
            "default": [
              "https://apps.apple.com/us/app/whatsapp-messenger/id310633997",
              "https://play.google.com/store/apps/details?id=com.whatsapp"
            ],
            "items": {
              "type": "string"
            }
          },
          "competitors": {
            "title": "Competitor apps",
            "type": "array",
            "description": "Optional rival apps. Each one is checked too (and billed as an app check) and compared with your apps on the same store: rating gap, and an alert when a competitor overtakes you or you overtake them. Same formats as 'Your apps'.",
            "default": [
              "https://apps.apple.com/us/app/telegram-messenger/id686449807",
              "https://play.google.com/store/apps/details?id=org.telegram.messenger"
            ],
            "items": {
              "type": "string"
            }
          },
          "reviewSample": {
            "title": "Reviews read per app and run",
            "minimum": 10,
            "maximum": 500,
            "type": "integer",
            "description": "How many of the newest reviews to read for the sentiment, 1-star and version figures. Bigger samples are steadier but slower. Apple's public feed gives at most about 500.",
            "default": 100
          },
          "country": {
            "title": "Store country",
            "type": "string",
            "description": "Two-letter store country for Apple and Google Play, e.g. us, gb, de, jp. Ratings are per storefront.",
            "default": "us"
          },
          "language": {
            "title": "Review language",
            "type": "string",
            "description": "Steam review language filter (english, german, all, ...) and Google Play interface language (en, de, ...).",
            "default": "english"
          },
          "ratingDropAlert": {
            "title": "Alert when the store rating falls by (hundredths of a star)",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Alert when the overall store rating is at least this much lower than at the previous run. Whole numbers only: 10 = 0.10 stars, 50 = half a star. The headline rating moves slowly for big apps, so small values are meaningful.",
            "default": 10
          },
          "recentRatingDropAlert": {
            "title": "Alert when recent reviews fall by (hundredths of a star)",
            "minimum": 1,
            "maximum": 400,
            "type": "integer",
            "description": "Alert when the average of the newest reviews is at least this much lower than at the previous run (needs 30+ reviews both times). 50 = half a star. Catches a bad release much earlier than the headline rating.",
            "default": 50
          },
          "negativeSpikePoints": {
            "title": "Alert when 1-2 star share jumps by (percentage points)",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Alert when the share of 1-2 star reviews among the newest reviews is at least this many points higher than at the previous run (15 = from 20% to 35%).",
            "default": 15
          },
          "newOneStarAlert": {
            "title": "Alert on N new 1-star reviews since last run",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "Alert when at least this many 1-star reviews appeared since the previous run. 0 turns this check off. Needs a previous run to compare with.",
            "default": 5
          },
          "versionRegressionDrop": {
            "title": "Flag a bad release when its rating is lower by (hundredths of a star)",
            "minimum": 0,
            "maximum": 400,
            "type": "integer",
            "description": "Version regression check: the newest app version's average review rating (at least 5 reviews) is compared with older versions in the same sample. 50 = flag when it is half a star worse. 0 turns this check off.",
            "default": 50
          },
          "slackWebhookUrl": {
            "title": "Slack webhook URL",
            "type": "string",
            "description": "Optional Slack incoming-webhook URL. A formatted message is posted when any alert fires.",
            "default": ""
          },
          "discordWebhookUrl": {
            "title": "Discord webhook URL",
            "type": "string",
            "description": "Optional Discord webhook URL. A formatted message is posted when any alert fires.",
            "default": ""
          },
          "webhookUrl": {
            "title": "Generic webhook URL",
            "type": "string",
            "description": "Optional URL that receives the alerts as JSON (event, summary, alerts[]). Works with Zapier, Make, n8n or your own endpoint.",
            "default": ""
          },
          "onlyAlerts": {
            "title": "Only output apps with alerts",
            "type": "boolean",
            "description": "Push only apps that raised an alert (plus broken apps). Off = one row per checked app every run, useful for charting.",
            "default": false
          },
          "resetBaseline": {
            "title": "Reset baseline",
            "type": "boolean",
            "description": "Forget the stored previous readings and treat this run as the first one.",
            "default": false
          },
          "keepHistory": {
            "title": "Rating history length",
            "minimum": 0,
            "maximum": 500,
            "type": "integer",
            "description": "How many past readings to keep per app (shown in each row's history field) so you can chart the rating over time.",
            "default": 60
          },
          "stateStoreName": {
            "title": "State store name",
            "type": "string",
            "description": "Named key-value store that remembers previous ratings between scheduled runs. Use a different name per monitoring job.",
            "default": "app-review-alerts-state"
          },
          "concurrency": {
            "title": "Concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "How many apps to check in parallel.",
            "default": 3
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Optional proxy. Normally not needed: if a store rate-limits the run, Apify's datacenter proxy is used automatically as a fallback.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}