{ "openapi": "3.0.1", "info": { "title": "App Store Review Analysis & Release Regression Monitor", "description": "Compare supplied App Store review cohorts by version or date. Get rule-assisted issue triage, rating changes and supporting review evidence. No direct scraping.", "version": "0.1", "x-build-id": "6eX1qXsAb9RgH1WWB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/exceptional_nugget~app-store-review-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-exceptional_nugget-app-store-review-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/exceptional_nugget~app-store-review-monitor/runs": { "post": { "operationId": "runs-sync-exceptional_nugget-app-store-review-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/exceptional_nugget~app-store-review-monitor/run-sync": { "post": { "operationId": "run-sync-exceptional_nugget-app-store-review-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", "required": [ "appId", "storefront", "comparisonMode" ], "properties": { "reviews": { "title": "Supplied review records", "type": "array", "description": "Supply review JSON OR select a dataset. See README for review field contract. Maximum 8 MiB; records beyond maximumReviews are excluded." }, "datasetId": { "title": "Source dataset (same account)", "type": "string", "description": "A completed dataset belonging to the running Apify account. Read-only permission; no cross-account datasets." }, "appId": { "title": "App identifier", "type": "string", "description": "Exact app ID label used in every input record." }, "storefront": { "title": "Storefront", "type": "string", "description": "One uppercase 2- or 3-letter code; must match supplied reviews." }, "comparisonMode": { "title": "Comparison mode", "enum": [ "version", "date" ], "type": "string", "description": "Versions are exact labels. Date windows use start-inclusive/end-exclusive timezone-qualified timestamps.", "default": "version" }, "currentVersion": { "title": "Current version label", "type": "string", "description": "Required for version mode. Never inferred or sorted." }, "baselineVersion": { "title": "Baseline version label", "type": "string", "description": "Required for version mode; different from current." }, "currentWindow": { "title": "Current date window", "type": "object", "description": "Date mode only: {\"start\":\"2026-09-01T00:00:00Z\",\"end\":\"2026-10-01T00:00:00Z\"}." }, "baselineWindow": { "title": "Baseline date window", "type": "object", "description": "Date mode only. Must end on or before current window starts." }, "maximumReviews": { "title": "Maximum input reviews", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Limit records read before validation/deduplication; first records win, so use a completed export.", "default": 1000 }, "minimumCohortSize": { "title": "Minimum English reviews per cohort", "minimum": 5, "maximum": 1000, "type": "integer", "description": "Heuristic sample threshold, not statistical significance.", "default": 20 }, "minimumIssueCount": { "title": "Minimum current issue matches", "minimum": 2, "maximum": 1000, "type": "integer", "description": "Required before a newly observed or more frequent flag.", "default": 3 }, "minimumShareChange": { "title": "Minimum absolute share increase", "minimum": 0, "maximum": 1, "type": "number", "description": "0.05 means five percentage points, not a relative percentage increase.", "default": 0.05 }, "reportDetail": { "title": "Report detail", "enum": [ "compact", "detailed" ], "type": "string", "description": "Detailed includes verified text excerpts, up to 180 characters each.", "default": "compact" }, "includeReviewText": { "title": "Include text in REVIEWS export", "type": "boolean", "description": "Input always retains supplied text. Detailed issue evidence may include excerpts independently.", "default": false }, "maximumChargeUsd": { "title": "Maximum analysis charge (USD)", "minimum": 0.002, "maximum": 25, "type": "number", "description": "Lower of this cap and platform cap applies. No paid startup fee.", "default": 2 }, "collectionLimitations": { "title": "Collection limitations", "type": "string", "description": "Describe export filters, capture dates, history limits and missing pages. This is shown as customer-supplied context." } } }, "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 } } } } } } } } } }