{ "openapi": "3.0.1", "info": { "title": "Steam Game Reviews & Player Feedback Analyzer", "description": "Extract Steam reviews and turn player feedback into structured bug reports, feature requests, sentiment topics, performance complaints, and actionable game insights.", "version": "0.1", "x-build-id": "SUUx58Jps584lit1C" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/obliging_persimmon_cki~steam-game-feedback-analyzer/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-obliging_persimmon_cki-steam-game-feedback-analyzer", "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/obliging_persimmon_cki~steam-game-feedback-analyzer/runs": { "post": { "operationId": "runs-sync-obliging_persimmon_cki-steam-game-feedback-analyzer", "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/obliging_persimmon_cki~steam-game-feedback-analyzer/run-sync": { "post": { "operationId": "run-sync-obliging_persimmon_cki-steam-game-feedback-analyzer", "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": { "mode": { "title": "Mode", "enum": [ "rawReviews", "feedbackAnalysis", "patchImpact" ], "type": "string", "description": "Collect raw reviews, attach deterministic analysis, or compare before/after review windows around a patch.", "default": "feedbackAnalysis" }, "steamAppIds": { "title": "Steam app IDs", "type": "array", "description": "One or more numeric Steam app IDs. Numeric strings are accepted by the runtime so the Console string-list editor can be used.", "items": { "type": "string", "pattern": "^[0-9]+$" }, "default": [ "730" ] }, "startUrls": { "title": "Steam Store URLs", "type": "array", "description": "Steam Store or community app URLs. App IDs are extracted and merged with steamAppIds.", "items": { "type": "object", "properties": { "url": { "title": "Steam URL", "description": "Steam Store or community app URL.", "type": "string" } }, "required": [ "url" ] } }, "languages": { "title": "Review languages", "type": "array", "description": "Steam language codes. Use all to request all languages.", "items": { "type": "string", "minLength": 1 }, "default": [ "all" ] }, "reviewFilter": { "title": "Review filter", "enum": [ "all", "positive", "negative" ], "type": "string", "description": "Return all reviews or only positive/negative recommendations.", "default": "all" }, "purchaseType": { "title": "Purchase type", "enum": [ "all", "steamPurchasers", "nonSteamPurchasers" ], "type": "string", "description": "Filter reviews by whether the reviewer purchased the game on Steam.", "default": "all" }, "dateRange": { "title": "Date range", "type": "object", "description": "Optional inclusive date bounds and recent-days limit for review collection.", "properties": { "from": { "title": "From", "description": "Inclusive ISO date lower bound. Leave blank to omit.", "type": "string", "default": "" }, "to": { "title": "To", "description": "Inclusive ISO date upper bound. Leave blank to omit.", "type": "string", "default": "" }, "recentDays": { "title": "Recent days", "description": "Keep reviews from this many recent days. Use 0 to disable the recent-days bound.", "type": "integer", "minimum": 0, "maximum": 3650, "default": 30 } } }, "maxReviewsPerGame": { "title": "Maximum reviews per game", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap on reviews collected for each Steam app.", "default": 100 }, "includeReviewText": { "title": "Include review text", "type": "boolean", "description": "Keep the original public review text in each output record.", "default": true }, "analysis": { "title": "Analysis settings", "type": "object", "description": "Settings reserved for the review-level analysis phase.", "properties": { "enabled": { "title": "Enabled", "description": "Enable review-level analysis.", "type": "boolean", "default": true }, "outputLanguage": { "title": "Output language", "description": "Language for normalized analysis summaries.", "type": "string", "enum": [ "english", "original" ], "default": "english" }, "includeSummary": { "title": "Include summary", "description": "Include a short review summary.", "type": "boolean", "default": true }, "includeTopics": { "title": "Include topics", "description": "Include stable topic IDs.", "type": "boolean", "default": true }, "includeSeverity": { "title": "Include severity", "description": "Include estimated issue severity.", "type": "boolean", "default": true }, "includeActionabilityScore": { "title": "Include actionability", "description": "Include the actionability score.", "type": "boolean", "default": true }, "includeEnvironmentSignals": { "title": "Include environment", "description": "Include platform and environment signals.", "type": "boolean", "default": true }, "clusterSimilarIssues": { "title": "Cluster similar issues", "description": "Enable duplicate issue clustering in later phases.", "type": "boolean", "default": true } } }, "aggregation": { "title": "Aggregation settings", "type": "object", "description": "Settings reserved for the per-game aggregation phase.", "properties": { "enabled": { "title": "Enabled", "description": "Enable per-game aggregation.", "type": "boolean", "default": true }, "minimumClusterSize": { "title": "Minimum cluster size", "description": "Minimum mentions for a cluster in later phases.", "type": "integer", "minimum": 1, "maximum": 100, "default": 2 }, "includeExampleReviews": { "title": "Include examples", "description": "Include example review IDs in aggregate output.", "type": "boolean", "default": true }, "maxExamplesPerTopic": { "title": "Maximum examples per topic", "description": "Maximum example review IDs retained for a topic.", "type": "integer", "minimum": 0, "maximum": 20, "default": 3 } } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify proxy settings for the collection layer.", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "description": "Route supported collection requests through Apify Proxy.", "type": "boolean", "default": false } } }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Emit additional diagnostic logs.", "default": false }, "patch": { "title": "Patch", "type": "object", "description": "Patch metadata for patchImpact mode.", "properties": { "releasedAt": { "title": "Released at", "description": "Patch release time as an ISO date-time.", "type": "string" }, "version": { "title": "Version", "description": "Optional patch version label.", "type": "string" }, "notesUrl": { "title": "Notes URL", "description": "Optional public patch-notes URL.", "type": "string" } } }, "daysBefore": { "title": "Days before patch", "minimum": 1, "maximum": 365, "type": "integer", "description": "Number of days in the before window.", "default": 14 }, "daysAfter": { "title": "Days after patch", "minimum": 1, "maximum": 365, "type": "integer", "description": "Number of days in the after window.", "default": 14 }, "maxReviewsPerPeriod": { "title": "Maximum reviews per period", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard cap for each patch comparison window.", "default": 1000 } } }, "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 } } } } } } } } } }