{ "openapi": "3.0.1", "info": { "title": "BugChorus — App Review Analyzer & Release Monitor", "description": "Turn App Store and Google Play reviews into ranked issue clusters, traceable evidence, and guarded release comparisons. Export HTML, JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "PLHeehsf7KscpPMpP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/reviewsignal~app-review-bug-detector/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-reviewsignal-app-review-bug-detector", "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/reviewsignal~app-review-bug-detector/runs": { "post": { "operationId": "runs-sync-reviewsignal-app-review-bug-detector", "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/reviewsignal~app-review-bug-detector/run-sync": { "post": { "operationId": "run-sync-reviewsignal-app-review-bug-detector", "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": [ "appUrls" ], "properties": { "appUrls": { "title": "App URLs or IDs", "minItems": 1, "maxItems": 20, "uniqueItems": true, "type": "array", "description": "Apple App Store URLs, Google Play URLs, ios:123456789, or android:com.example.app. Maximum 20 apps per run.", "items": { "type": "string", "minLength": 3 } }, "countries": { "title": "Store countries", "minItems": 1, "maxItems": 5, "uniqueItems": true, "type": "array", "description": "Analyze each app in these two-letter storefronts. Multi-country runs are useful for localization and regional regressions.", "items": { "type": "string", "enumSuggestedValues": [ "us", "gb", "ca", "au", "de", "fr", "es", "it", "br", "mx", "in", "jp" ], "enumTitles": [ "United States", "United Kingdom", "Canada", "Australia", "Germany", "France", "Spain", "Italy", "Brazil", "Mexico", "India", "Japan" ] }, "default": [ "us" ] }, "language": { "title": "Google Play language", "pattern": "^[a-zA-Z]{2}$", "type": "string", "description": "Two-letter language code used for Google Play. Issue classification is optimized for English review text in this version.", "default": "en" }, "daysBack": { "title": "Review window in days", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only reviews this recent are analyzed.", "default": 30 }, "maxReviewsPerAppCountry": { "title": "Maximum reviews per app and country", "minimum": 20, "maximum": 500, "type": "integer", "description": "The newest reviews fetched before the date and rating filters are applied. Apple exposes at most 500 reviews per app and country.", "default": 300 }, "focusRatings": { "title": "Ratings treated as issue evidence", "minItems": 1, "uniqueItems": true, "type": "array", "description": "The regression calculation still uses all fetched ratings. This selection controls issue clusters and evidence.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] }, "default": [ "1", "2", "3" ] }, "minReviewsForRegression": { "title": "Minimum reviews per compared version", "minimum": 3, "maximum": 50, "type": "integer", "description": "Prevents strong release claims from tiny samples. Five is useful for small apps; ten or more is safer for high-volume apps.", "default": 5 }, "mode": { "title": "Run mode", "enum": [ "snapshot", "monitor" ], "type": "string", "description": "Snapshot analyzes the current window. Monitor also remembers review IDs in a dedicated Actor-created store so scheduled runs can identify genuinely new reviews.", "default": "snapshot" }, "stateKey": { "title": "Monitor name", "pattern": "^[a-zA-Z0-9_-]*$", "maxLength": 60, "type": "string", "description": "Optional stable name for the monitor state, for example my-production-apps. Leave blank to derive it from the app list.", "default": "" }, "includeRawReviews": { "title": "Include normalized review rows inside each report", "type": "boolean", "description": "Off by default to keep reports compact. Evidence examples and grouped issues are always included.", "default": false }, "maxEvidencePerIssue": { "title": "Evidence examples per issue", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum quoted review examples retained for each issue cluster.", "default": 3 } } }, "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 } } }, "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 } } } } } } } } } }