{ "openapi": "3.0.1", "info": { "title": "BoardDocs School Board Agendas Scraper by District", "description": "Pulls school board agenda items from BoardDocs portals, with filters for district, committee, date range and keywords, optional item text and attachment links, charged per result.", "version": "0.1", "x-build-id": "d3sfWkmLLr4HEwN4i" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/talcoe~boarddocs-agendas/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-talcoe-boarddocs-agendas", "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/talcoe~boarddocs-agendas/runs": { "post": { "operationId": "runs-sync-talcoe-boarddocs-agendas", "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/talcoe~boarddocs-agendas/run-sync": { "post": { "operationId": "run-sync-talcoe-boarddocs-agendas", "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", "required": [ "districts" ], "properties": { "districts": { "title": "Districts", "type": "array", "description": "BoardDocs portals to read. Use the state and slug from the portal address, for example ca/sandi for go.boarddocs.com/ca/sandi/Board.nsf/Public, or paste the full URL.", "default": [ "ca/sandi", "tx/hisd" ], "items": { "type": "string" } }, "committees": { "title": "Committees", "type": "array", "description": "Only read committees whose name contains one of these words. Leave empty for the main governing board (the first committee listed). Use * for every committee.", "default": [], "items": { "type": "string" } }, "dateFrom": { "title": "Meetings from", "type": "string", "description": "Earliest meeting date, YYYY-MM-DD. Leave empty for no lower bound.", "default": "" }, "dateTo": { "title": "Meetings until", "type": "string", "description": "Latest meeting date, YYYY-MM-DD. Leave empty for no upper bound.", "default": "" }, "keywords": { "title": "Keywords", "type": "array", "description": "Only keep agenda items whose category, title or text contains any of these words. Leave empty to keep everything. Matching on item text needs extra requests, so runs with keywords are slower.", "default": [], "items": { "type": "string" } }, "maxMeetingsPerCommittee": { "title": "Meetings per committee", "minimum": 1, "maximum": 500, "type": "integer", "description": "Newest meetings to read per committee inside the date window.", "default": 2 }, "includeItemDetails": { "title": "Include item text and attachments", "type": "boolean", "description": "Adds the item description text and public attachment links. Needs extra requests per item, so the run is slower.", "default": false }, "maxResults": { "title": "Max results", "minimum": 1, "type": "integer", "description": "Hard stop for the run. You are billed per result, so this caps the cost.", "default": 100 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify proxy is recommended for larger runs.", "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 }, "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 } } } } } } } } } }