{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store & Google Play Reviews and Ratings Tracker",
    "description": "App Store + Google Play in one run: ratings, 1-5★ histogram, app details and the reviews each store shows, per country (all 175). Monitoring mode: only new reviews and rating changes. One stable schema, dedup, GDPR pseudonyms. Never pay for empty results.",
    "version": "0.1",
    "x-build-id": "SoMaFr5rQddGHp5nJ"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/nat-labs~app-store-reviews-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-nat-labs-app-store-reviews-scraper",
        "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/nat-labs~app-store-reviews-scraper/runs": {
      "post": {
        "operationId": "runs-sync-nat-labs-app-store-reviews-scraper",
        "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/nat-labs~app-store-reviews-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-nat-labs-app-store-reviews-scraper",
        "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": "Apps (links or ids, both stores)",
            "type": "array",
            "description": "Mix both stores freely: App Store links (<code>https://apps.apple.com/us/app/instagram/id389801252</code>), Apple ids (<code>389801252</code>, <code>id389801252</code>), Google Play links (<code>https://play.google.com/store/apps/details?id=com.whatsapp</code>) or Android package names (<code>com.whatsapp</code>). Apple bundle ids work with a prefix: <code>apple:com.burbn.instagram</code>. Searching by app name is not possible — both stores disallow automated search.",
            "items": {
              "type": "string"
            }
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "One app row per app per country, each with that country's own rating, histogram and reviews. Codes (<code>us</code>, <code>NG</code>), names (<code>Germany</code>), <code>top</code> (40 largest app markets) or <code>all</code> (all 175 App Store countries). Empty = the country in the app link, else <code>us</code>.",
            "items": {
              "type": "string"
            }
          },
          "languages": {
            "title": "Google Play review languages",
            "type": "array",
            "description": "Google Play only shows reviews in the page language. Leave empty to use each country's main language automatically (Germany → de, Brazil → pt-BR, Nigeria → en). Add several (e.g. <code>en</code>, <code>es</code>) to collect each language's reviews. The App Store ignores this.",
            "items": {
              "type": "string"
            }
          },
          "includeReviews": {
            "title": "Include reviews",
            "type": "boolean",
            "description": "Deliver the reviews each store page shows: up to 18 per country on the App Store (10 featured + 8 most helpful), 20 per country and language on Google Play, with developer replies, app version and thumbs-up where the store has them. Turn off for ratings/histogram tracking only.",
            "default": true
          },
          "includeAppDetails": {
            "title": "Include app rows (rating, histogram, details)",
            "type": "boolean",
            "description": "One row per app per country: average rating, rating count, 1–5★ histogram, review count (Google Play), installs, price, version, last update, genre, developer.",
            "default": true
          },
          "includeDescription": {
            "title": "Include description and screenshots",
            "type": "boolean",
            "description": "Add the store description and screenshot links to each app row. Turn off for slimmer CSV/Excel exports.",
            "default": true
          },
          "includeSummary": {
            "title": "Include a summary across countries",
            "type": "boolean",
            "description": "When an app is checked in 2+ countries, add one free summary row: global rating weighted by each country's ratings, summed histogram, best and worst country.",
            "default": true
          },
          "onlyNew": {
            "title": "Only new (monitoring mode)",
            "type": "boolean",
            "description": "For scheduled runs: deliver only reviews no earlier run delivered, and app rows only when the rating, rating count, histogram or version changed — with per-star deltas (e.g. 12 new 1★ ratings in Germany). The first run is the baseline. Unchanged apps cost a cheap <i>monitor check</i>.",
            "default": false
          },
          "monitorName": {
            "title": "Monitor name",
            "type": "string",
            "description": "Separate memory per schedule. Use a different name for each watch list (e.g. <code>my-apps</code>, <code>competitors</code>).",
            "default": "default"
          },
          "ratings": {
            "title": "Only these star ratings",
            "type": "array",
            "description": "Keep only reviews with these stars, e.g. <code>[1, 2]</code> for complaints. Empty = all."
          },
          "since": {
            "title": "Reviews since",
            "type": "string",
            "description": "Keep reviews on or after this date: <code>2026-01-01</code> or a window like <code>30d</code>, <code>2w</code>, <code>6m</code>."
          },
          "until": {
            "title": "Reviews until",
            "type": "string",
            "description": "Keep reviews up to and including this date (<code>2026-06-30</code>)."
          },
          "keywords": {
            "title": "Keywords",
            "type": "array",
            "description": "Keep reviews whose title or text contains any of these words (case-insensitive), e.g. <code>crash</code>, <code>login</code>, <code>refund</code>.",
            "items": {
              "type": "string"
            }
          },
          "appVersions": {
            "title": "App versions",
            "type": "array",
            "description": "Keep reviews written on these app versions (prefix match: <code>2.26</code> matches 2.26.33.74). Google Play only — the App Store page does not show the version.",
            "items": {
              "type": "string"
            }
          },
          "onlyWithReply": {
            "title": "Only reviews with a developer reply",
            "type": "boolean",
            "description": "Keep only reviews the developer answered.",
            "default": false
          },
          "sortBy": {
            "title": "Sort reviews",
            "enum": [
              "newest",
              "oldest",
              "rating-asc",
              "rating-desc",
              "helpful",
              "store"
            ],
            "type": "string",
            "description": "Order of reviews within each app and country.",
            "default": "newest"
          },
          "maxReviews": {
            "title": "Max reviews per run",
            "minimum": 0,
            "type": "integer",
            "description": "Stop delivering reviews after this many in total. 0 = no limit.",
            "default": 0
          },
          "maxReviewsPerApp": {
            "title": "Max reviews per app",
            "minimum": 0,
            "type": "integer",
            "description": "Per app, across all its countries and languages. 0 = no limit.",
            "default": 0
          },
          "reviewerNames": {
            "title": "Reviewer names",
            "enum": [
              "pseudonymize",
              "include",
              "omit"
            ],
            "type": "string",
            "description": "Reviewer names are personal data. <b>Pseudonymize</b> (default) replaces each name with a stable code like <code>user_3f9a…</code> — the same reviewer gets the same code across runs and apps, so analysis still works — and drops avatars. <b>Include</b> keeps the public display name and avatar; <b>Omit</b> removes both.",
            "default": "pseudonymize"
          },
          "appleReviewSources": {
            "title": "App Store review sources",
            "type": "array",
            "description": "<code>featured</code> = the Ratings & Reviews page (10 reviews, also gives the histogram); <code>mostHelpful</code> = the product page (8 most helpful reviews, one more request).",
            "default": [
              "featured",
              "mostHelpful"
            ],
            "items": {
              "type": "string"
            }
          },
          "maxConcurrency": {
            "title": "Parallel requests",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "App × country checks run in parallel, each on its own proxy IP.",
            "default": 4
          },
          "proxyConfiguration": {
            "title": "Proxy",
            "type": "object",
            "description": "Default: Apify datacenter proxy, included in the price. You can bring your own proxy URLs. Residential proxy is not needed for these public pages and is not used.",
            "default": {
              "useApifyProxy": true
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}