{ "openapi": "3.0.1", "info": { "title": "Shopify App Store Reviews Scraper with Review Themes", "description": "Scrape Shopify App Store reviews (rating, text, date, merchant country, time using the app, developer reply) and get an automatic report of top complaints and praise with counts and example quotes.", "version": "0.1", "x-build-id": "qcNajFxmaDl9LGIBD" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tidydata-labs~shopify-app-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tidydata-labs-shopify-app-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/tidydata-labs~shopify-app-reviews-scraper/runs": { "post": { "operationId": "runs-sync-tidydata-labs-shopify-app-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/tidydata-labs~shopify-app-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-tidydata-labs-shopify-app-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": "Shopify apps", "type": "array", "description": "Shopify App Store URLs (https://apps.shopify.com/klaviyo-email-marketing) or app handles (klaviyo-email-marketing).", "items": { "type": "string" } }, "maxReviewsPerApp": { "title": "Max reviews per app", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum reviews to save per item. You are charged per saved review.", "default": 500 }, "sortBy": { "title": "Sort by", "enum": [ "newest", "mostRelevant" ], "type": "string", "description": "Which reviews to collect first.", "default": "newest" }, "minRating": { "title": "Minimum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only keep reviews with at least this many stars.", "default": 1 }, "maxRating": { "title": "Maximum star rating", "minimum": 1, "maximum": 5, "type": "integer", "description": "Only keep reviews with at most this many stars. Set to 2 to collect only complaints (fast: low-rated reviews are fetched directly).", "default": 5 }, "reviewedAfter": { "title": "Reviews posted after", "type": "string", "description": "Only keep reviews posted on or after this date (YYYY-MM-DD)." }, "skipEmptyReviews": { "title": "Skip rating-only reviews", "type": "boolean", "description": "Leave out reviews that have stars but no text.", "default": false }, "generateThemesReport": { "title": "Generate review themes report", "type": "boolean", "description": "Build a report per item with top complaint and praise themes, counts, share of reviews, example quotes, frequent phrases and rating by version. Saved to the key-value store as THEMES. Charged once per item.", "default": true }, "useClaudeSummary": { "title": "Add AI summary with Claude (optional)", "type": "boolean", "description": "Also ask Claude to summarize themes, feature requests and suggested fixes. Requires your own Anthropic API key; typically a few cents per item on your Anthropic bill.", "default": false }, "anthropicApiKey": { "title": "Anthropic API key", "type": "string", "description": "Your Anthropic API key, used only for the AI summary. Stored encrypted." }, "claudeModel": { "title": "Claude model", "enum": [ "claude-haiku-4-5", "claude-sonnet-5-5" ], "type": "string", "description": "Haiku is cheapest; Sonnet gives richer summaries.", "default": "claude-haiku-4-5" } } }, "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 } } } } } } } } } }