{
  "openapi": "3.0.1",
  "info": {
    "title": "App Store Ratings & Reviews Monitor – iOS & Mac, All Countries",
    "description": "Track Apple App Store ratings and reviews for your apps and competitors in any country. Rating snapshots, latest reviews (no reviewer names) and monitor mode: rating, version and new-review changes since your last run. Public Apple endpoints, no login, no proxy.",
    "version": "0.1",
    "x-build-id": "CHj3HMIFgcNGyOZMM"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/tinlark~app-store-ratings-reviews-monitor/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-tinlark-app-store-ratings-reviews-monitor",
        "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/tinlark~app-store-ratings-reviews-monitor/runs": {
      "post": {
        "operationId": "runs-sync-tinlark-app-store-ratings-reviews-monitor",
        "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/tinlark~app-store-ratings-reviews-monitor/run-sync": {
      "post": {
        "operationId": "run-sync-tinlark-app-store-ratings-reviews-monitor",
        "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",
            "type": "array",
            "description": "One entry per app: an App Store id (389801252), an App Store link (https://apps.apple.com/us/app/instagram/id389801252) or a bundle id (com.burbn.instagram). iOS and Mac apps. Leave empty if you use a search term.",
            "items": {
              "type": "string"
            }
          },
          "searchTerm": {
            "title": "Search term (optional)",
            "type": "string",
            "description": "Find apps by name or keyword and add the top results to the list above. The search runs in the first country of your list."
          },
          "searchPlatform": {
            "title": "Search in",
            "enum": [
              "ios",
              "mac",
              "both"
            ],
            "type": "string",
            "description": "Which store the search term looks in.",
            "default": "ios"
          },
          "searchLimit": {
            "title": "Apps per search",
            "minimum": 1,
            "maximum": 50,
            "type": "integer",
            "description": "How many search results to add (per store).",
            "default": 5
          },
          "countries": {
            "title": "Countries",
            "type": "array",
            "description": "Two-letter App Store storefront codes such as us, gb, de, jp, fr, br. Write all for every storefront (about 175). Apple allows about 20 calls a minute per endpoint, so all countries for a few apps takes several minutes.",
            "default": [
              "us"
            ],
            "items": {
              "type": "string"
            }
          },
          "mode": {
            "title": "Mode",
            "enum": [
              "snapshot",
              "reviews",
              "monitor"
            ],
            "type": "string",
            "description": "snapshot: one row per app and country with rating, rating count, version and price. reviews: the latest customer reviews. monitor: what changed since the last run (rating, rating count, version, price, new reviews); the first run only records a free baseline. Needs a State name.",
            "default": "snapshot"
          },
          "maxReviewsPerAppCountry": {
            "title": "Max reviews per app and country",
            "minimum": 1,
            "maximum": 500,
            "type": "integer",
            "description": "Reviews and monitor modes. Apple's public feed shows at most the 500 most recent reviews per app and country, 50 per call.",
            "default": 50
          },
          "reviewSort": {
            "title": "Review order",
            "enum": [
              "recent",
              "helpful"
            ],
            "type": "string",
            "description": "Reviews mode only. recent: newest first. helpful: most helpful first (within the same 500-review window). Monitor mode always reads the newest reviews.",
            "default": "recent"
          },
          "sinceDate": {
            "title": "Reviews since (optional)",
            "type": "string",
            "description": "Keep only reviews written or last edited on or after this date, for example 2026-09-01."
          },
          "minRating": {
            "title": "Lowest star rating to keep",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Reviews and monitor modes. 1 keeps everything.",
            "default": 1
          },
          "maxRating": {
            "title": "Highest star rating to keep",
            "minimum": 1,
            "maximum": 5,
            "type": "integer",
            "description": "Reviews and monitor modes. Set to 2 to watch for unhappy customers only.",
            "default": 5
          },
          "maxItems": {
            "title": "Max rows in total",
            "minimum": 1,
            "maximum": 10000000,
            "type": "integer",
            "description": "Stops the run once this many billable rows (app snapshots and reviews) were produced.",
            "default": 1000
          },
          "stateKey": {
            "title": "State name",
            "pattern": "^[a-z0-9][a-z0-9-]{0,40}$",
            "type": "string",
            "description": "Monitor mode. Lowercase letters, digits and hyphens. Saves what was seen in a named storage so later runs report only the changes. Use the same name on every scheduled run, and a different name for each watch list."
          },
          "trackReviews": {
            "title": "Monitor: also track new reviews",
            "type": "boolean",
            "description": "Monitor mode. Turn off to watch only rating, rating count, version and price. That uses far fewer calls to Apple.",
            "default": true
          },
          "emitUnchanged": {
            "title": "Monitor: also return unchanged apps",
            "type": "boolean",
            "description": "Monitor mode. By default an app and country with no change since the last run returns no row (and costs nothing). Turn on to get a row for every app and country on every run.",
            "default": 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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}