{ "openapi": "3.0.1", "info": { "title": "kununu Company Profile Scraper โ€” DACH Ratings & Awards", "description": "Scrape kununu company profiles across Germany, Austria and Switzerland โ€” overall score, the full rating-factor breakdown, review counts, recommendation rate, score trend and awards. One record per company, with built-in incremental monitoring and change alerts.", "version": "0.1", "x-build-id": "LFOvhkdKojRUQCuJy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/corvuslab~kununu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-corvuslab-kununu-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/corvuslab~kununu-scraper/runs": { "post": { "operationId": "runs-sync-corvuslab-kununu-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/corvuslab~kununu-scraper/run-sync": { "post": { "operationId": "run-sync-corvuslab-kununu-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": "๐Ÿข Company URLs or slugs", "type": "array", "description": "Each entry can be a full profile URL (https://www.kununu.com/de/sap), a country/slug path (at/red-bull-gmbh) or a bare slug (sap). A bare slug uses the default country below.", "items": { "type": "string" } }, "country": { "title": "๐ŸŒ Default country", "enum": [ "de", "at", "ch" ], "type": "string", "description": "Country to assume for bare slugs that don't include one. kununu covers the DACH region.", "default": "de" }, "startUrls": { "title": "๐Ÿ“‹ Start URLs (alias)", "type": "array", "description": "Alternative to 'Company URLs' โ€” accepts the same values. Useful when chaining from another actor.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxResults": { "title": "๐Ÿ”ข Max companies", "minimum": 0, "type": "integer", "description": "Maximum number of company profiles to return. Set 0 for no limit (bounded by how many you provide).", "default": 25 }, "ignoreUrlFailures": { "title": "โญ๏ธ Skip missing companies", "type": "boolean", "description": "Skip company slugs that don't exist instead of failing the whole run.", "default": true }, "compact": { "title": "๐Ÿ“ฆ Compact records", "type": "boolean", "description": "Emit only the core fields (name, URL, score, review count, recommendation rate). Ideal for AI agents and MCP clients.", "default": false }, "excludeEmptyFields": { "title": "๐Ÿงน Drop empty fields", "type": "boolean", "description": "Remove null, empty-string and empty-array fields from each record.", "default": false }, "includeFactorRatings": { "title": "โญ Include rating-factor breakdown", "type": "boolean", "description": "Include the per-factor score breakdown (work atmosphere, work-life balance, management, salary, etc.). Turning this off is faster and cheaper when you only need the overall score, review counts and recommendation rate.", "default": true }, "includeSalaryBenefits": { "title": "๐Ÿ’ถ Include salary & benefits", "type": "boolean", "description": "Include salary ranges by job title (min/max/median/average), salary-satisfaction split and the benefits list with the share of employees reporting each. Read from the same page, so this only shapes the output โ€” turn off for leaner records.", "default": true }, "incrementalMode": { "title": "โ™ป๏ธ Incremental mode", "type": "boolean", "description": "Track state between runs and tag every record with a changeType (NEW / UPDATED / UNCHANGED / EXPIRED).", "default": false }, "stateKey": { "title": "๐Ÿ—๏ธ State key", "type": "string", "description": "Stable name for the tracked company set. Leave empty to derive one automatically from your inputs." }, "emitUnchanged": { "title": "๐Ÿ” Include unchanged companies", "type": "boolean", "description": "Also emit companies that have not changed since the previous run.", "default": false }, "emitExpired": { "title": "๐Ÿ—‘๏ธ Include removed companies", "type": "boolean", "description": "Emit records for companies present last run but not in this one.", "default": false }, "telegramToken": { "title": "๐Ÿ’ฌ Telegram bot token", "type": "string", "description": "Bot token from @BotFather." }, "telegramChatId": { "title": "๐Ÿ†” Telegram chat ID", "type": "string", "description": "Chat or channel ID, e.g. \"-100123456789\" or \"@yourchannel\"." }, "slackWebhookUrl": { "title": "๐Ÿ’ผ Slack webhook URL", "type": "string", "description": "Slack incoming-webhook URL." }, "discordWebhookUrl": { "title": "๐ŸŽฎ Discord webhook URL", "type": "string", "description": "Discord incoming-webhook URL." }, "webhookUrl": { "title": "๐Ÿช Webhook URL", "type": "string", "description": "Any HTTPS endpoint. Receives a JSON POST with the matched records โ€” works with n8n, Make and Zapier." }, "webhookHeaders": { "title": "๐Ÿงพ Webhook headers", "type": "object", "description": "Extra headers for the webhook request, e.g. {\"Authorization\": \"Bearer xyz\"}." }, "notificationLimit": { "title": "๐Ÿ”ข Records per notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many records to include in each notification message.", "default": 5 }, "proxyConfiguration": { "title": "๐ŸŒ Proxy configuration", "type": "object", "description": "Runs fine with no proxy by default. For very large runs, or if you start seeing blocks, enable Apify Proxy (residential) as a fallback.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }