{ "openapi": "3.0.1", "info": { "title": "Reclame Aqui Scraper - Consumer Complaints BR", "description": "Extract Reclame Aqui data: company complaints, ratings, response rates.", "version": "2.9", "x-build-id": "mBACT1hcgekRKnZNf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/viralanalyzer~reclameaqui-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-viralanalyzer-reclameaqui-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/viralanalyzer~reclameaqui-scraper/runs": { "post": { "operationId": "runs-sync-viralanalyzer-reclameaqui-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/viralanalyzer~reclameaqui-scraper/run-sync": { "post": { "operationId": "run-sync-viralanalyzer-reclameaqui-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": { "companies": { "title": "Companies", "type": "array", "description": "List of company slugs to scrape (e.g. ['nubank', 'itau', 'magazine-luiza']). Use the slug from the Reclame Aqui URL.", "items": { "type": "string" } }, "searchQuery": { "title": "Keyword Filter", "type": "string", "description": "Keyword kept only if it appears in the complaint title or description (case- and accent-insensitive substring). IMPORTANT: this filters the complaints of the companies you listed — it is NOT a site-wide search. It is evaluated against every complaint the company's list page returns; 'maxComplaints' caps how many are DELIVERED, not how many are scanned, so raising it does not make a rare keyword match. Applied in memory before billing, so filtered-out complaints are never charged. If nothing matches, the run SUCCEEDS with a diagnostic item saying how many complaints were scanned, and charges nothing. Leave empty to keep every complaint." }, "maxComplaints": { "title": "Max Complaints", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of complaints to extract per company", "default": 20 }, "statusFilter": { "title": "Status Filter", "enum": [ "all", "Respondida", "Não respondida", "Resolvida", "Não resolvida", "Em réplica" ], "type": "string", "description": "Filter complaints by status", "default": "all" }, "includeCompanyStats": { "title": "Include Company Stats", "type": "boolean", "description": "Include company reputation score, response rate, and resolve rate", "default": true }, "dateFrom": { "title": "Date From", "type": "string", "description": "Keep only complaints created on or after this date, inclusive (YYYY-MM-DD, UTC). Filters the complaint dates already extracted, before billing. When a date filter is set, complaints whose date cannot be determined are discarded. Leave empty for no filter." }, "dateTo": { "title": "Date To", "type": "string", "description": "Keep only complaints created on or before this date, inclusive (YYYY-MM-DD, UTC). Filters the complaint dates already extracted, before billing. When a date filter is set, complaints whose date cannot be determined are discarded. Leave empty for no filter." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Recommended: Apify Proxy with country code BR, or custom BR residential proxies.", "default": { "useApifyProxy": true } }, "brightDataApiToken": { "title": "Bright Data API token (optional, BYO)", "type": "string", "description": "Optional. Complaint list and detail pages are fetched through Bright Data's Web Unlocker (no browser, no residential proxy) using the actor's own account. Provide your own token to use your Bright Data account instead." } } }, "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 } } } } } } } } } }