{ "openapi": "3.0.1", "info": { "title": "Backloggd Game Reviews & Database Scraper", "description": "Track Backloggd launches, ratings, community activity, reviews, and changes. Export game intelligence, launch cohorts, and optional AI feedback summaries.", "version": "1.0", "x-build-id": "LopkBBnamYHSETXeb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thescrapelab~backloggd-game-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thescrapelab-backloggd-game-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/thescrapelab~backloggd-game-reviews-scraper/runs": { "post": { "operationId": "runs-sync-thescrapelab-backloggd-game-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/thescrapelab~backloggd-game-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-thescrapelab-backloggd-game-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": { "searchQueries": { "title": "Search by game title", "type": "array", "description": "Enter one or more titles, such as Elden Ring, Hades, or Baldur's Gate 3. Each title returns up to five ranked matches.", "items": { "type": "string" }, "default": [] }, "gameUrls": { "title": "Backloggd game URLs", "type": "array", "description": "Paste public game-page URLs such as https://backloggd.com/games/elden-ring/. Other Backloggd page types are not supported.", "items": { "type": "string" }, "default": [] }, "gameIdsOrSlugs": { "title": "Game slugs or numeric IDs (optional)", "type": "array", "description": "Advanced shortcut for known slugs such as elden-ring. Numeric IDs are accepted but may not resolve; URLs and slugs are more reliable.", "items": { "type": "string" }, "default": [] }, "maxReviewsPerGame": { "title": "Maximum reviews per game", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Maximum public written reviews to collect for each resolved game. Use 0 when you only need game metadata.", "default": 10 }, "outputMode": { "title": "Dataset content", "enum": [ "games_only", "reviews_only", "games_and_reviews", "summaries_only", "reviews_and_summaries", "launch_intelligence", "full" ], "type": "string", "description": "Choose the rows written to the Dataset. AI summaries require Review summaries only, Reviews + summaries, or Everything.", "default": "games_and_reviews" }, "launchWindowDays": { "title": "Launch window in days", "minimum": 7, "maximum": 365, "type": "integer", "description": "For launch intelligence, treat reviews from release through this many days after release as the launch cohort.", "default": 90 }, "monitoringMode": { "title": "Change monitoring", "enum": [ "snapshot", "compare_and_update" ], "type": "string", "description": "Compare games and reviews with the last fully successful snapshot stored for your monitoring key.", "default": "snapshot" }, "monitoringKey": { "title": "Monitoring key", "maxLength": 120, "type": "string", "description": "Required for compare-and-update mode. Use a separate private key for each project or source set.", "default": "" }, "spoilerHandling": { "title": "Spoiler reviews", "enum": [ "include", "exclude_from_ai", "exclude_completely" ], "type": "string", "description": "Keep spoiler-marked reviews, keep them out of AI analysis, or exclude them from the Dataset entirely.", "default": "exclude_from_ai" }, "includeOpenRouterAnalysis": { "title": "Generate AI game-review summaries", "type": "boolean", "description": "Adds spoiler-safe sentiment, praise, complaint, performance, and platform insights to summary rows. Select a Dataset content option that includes summaries. No API key input is required.", "default": false }, "maxReviewsToAnalyzePerGame": { "title": "Maximum reviews analyzed per game", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Limits AI usage for each game. Raw scraping can continue up to Maximum reviews per game.", "default": 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 } } } } } } } } } }