{ "openapi": "3.0.1", "info": { "title": "Board Dashboard - Monthly Board Pack With Early Warning", "description": "Turn monthly financials, budget, scorecard and board actions into a one-file board dashboard: a one-line thesis, ten verdict-led pages, ten early-warning triggers and board questions with owners. HTML, PDF, Excel, JSON; optional encryption.", "version": "1.0", "x-build-id": "LXb5cEbffarT1BNE0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bloom-consulting~board-dashboard/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bloom-consulting-board-dashboard", "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/bloom-consulting~board-dashboard/runs": { "post": { "operationId": "runs-sync-bloom-consulting-board-dashboard", "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/bloom-consulting~board-dashboard/run-sync": { "post": { "operationId": "run-sync-bloom-consulting-board-dashboard", "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": { "useSampleData": { "title": "Run with sample data", "type": "boolean", "description": "Ignore the fields below and run on a built-in example company (packaging SME, 20 months of actuals, budget, scorecard and board actions). Use this first to see the dashboard. Output produced this way is stamped DEMO.", "default": false }, "boardInput": { "title": "Board data", "type": "object", "description": "monthly: one row per month with month (2026-08), revenue, revenueBudget, cogs or grossProfit, ebitda, ebitdaBudget, netProfit, cash, cashBudget, operatingCashFlow, capex (positive), receivables, inventory, payables, financialDebt, headcount, customers. Give 13-24 months for year-on-year comparisons; 3 months is the minimum. periodEnd is the last actual month. kpis: name, owner, weight (sums to 100), min (score 50), target (100), max (150), actual, direction (higher | lower). actions: action, owner, due, status (open | done); open actions past their due date count as overdue. thesis overrides the one-sentence message the engine derives. If figures are in thousands set unitDivisor to 1000. English and Turkish field names are both accepted." }, "inputFileUrl": { "title": "Input file URL (Excel or JSON)", "type": "string", "description": "Alternative to the field above: a public http(s) URL of the Excel template (sheets Sirket, Aylik, KPI, Aksiyonlar, Kaynaklar; download it from this Actor's README) or a JSON file with the same data. Used only when \"Board data\" is empty." }, "companyName": { "title": "Company name", "type": "string", "description": "Overrides the company name inside the data. Leave empty to keep it." }, "language": { "title": "Dashboard language", "enum": [ "en", "tr" ], "type": "string", "description": "Language of the board card, dashboard, PDF and spreadsheet.", "default": "en" }, "generatePdf": { "title": "Generate PDF", "type": "boolean", "description": "Print every dashboard page to a landscape A4 PDF with headless Chromium. Skipped automatically when a password is set. Turn off for a faster, cheaper run.", "default": true }, "dashboardPassword": { "title": "Dashboard password (optional)", "type": "string", "description": "Encrypts the dashboard file with AES-256 (PBKDF2-SHA256 key). The file asks for the password when opened and decrypts locally in the browser. At least 8 characters. Send the file and the password through different channels. The JSON and Excel records in the key-value store are not encrypted; they stay private to your Apify account." } } }, "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 } } } } } } } } } }