{ "openapi": "3.0.1", "info": { "title": "Decidim Participation Extractor", "description": "Point at ANY Decidim instance and extract participatory-democracy data over its public GraphQL API. Modes: participatory processes, assemblies, proposals, results, meetings. One flat row per object, translated-text fallback, Relay pagination.", "version": "0.1", "x-build-id": "VYw9akELJbG82Po3f" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~decidim-participation-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-decidim-participation-extractor", "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/datamule~decidim-participation-extractor/runs": { "post": { "operationId": "runs-sync-datamule-decidim-participation-extractor", "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/datamule~decidim-participation-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-decidim-participation-extractor", "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": [ "decidimUrl" ], "properties": { "decidimUrl": { "title": "Decidim instance URL", "type": "string", "description": "Root URL of ANY Decidim participatory-democracy instance (the open-source platform behind ~400 city / regional / EU government deployments). Its public GraphQL API is read at /api. Examples: https://www.decidim.barcelona · https://meta.decidim.org · https://omastadi.hel.fi. You may pass the root or the full /api URL — both work." }, "mode": { "title": "Mode (what to extract)", "enum": [ "participatoryProcesses", "assemblies", "proposals", "results", "meetings" ], "type": "string", "description": "Which participatory object to extract. 'participatoryProcesses' and 'assemblies' are top-level participatory spaces (one row per space). 'proposals', 'results' and 'meetings' are COMPONENTS that hang off each participatory process — the actor discovers every matching component and paginates all of them (one flat row per leaf object).", "default": "participatoryProcesses" }, "withComponents": { "title": "Include components (space modes only)", "type": "boolean", "description": "Only for 'participatoryProcesses' / 'assemblies': expand each space's components list (id, type, name) into the row as a JSON string + a count. Ignored for component modes.", "default": false }, "locale": { "title": "Content locale", "type": "string", "description": "Preferred locale for translatable text (title / subtitle / body). Decidim stores these as translated objects; if the requested locale is missing on an instance (many Catalan / Finnish instances have no 'en'), the actor falls back to the first available translation and reports which locale it used in 'titleLocale'.", "default": "en" }, "maxRecords": { "title": "Max records", "minimum": 1, "type": "integer", "description": "Stop after emitting this many rows. For component modes, pagination across components halts once reached. Each emitted object is billed as one record.", "default": 2000 }, "pageSize": { "title": "Page size (component modes)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Objects requested per Relay page when paginating a component collection (the GraphQL 'first' argument). Space lists are un-paginated and ignore this. Decidim caps this near 100.", "default": 50 }, "userAgent": { "title": "User-Agent (optional)", "type": "string", "description": "Override the default descriptive User-Agent header. Many Decidim instances are public-sector / civic deployments — please keep a descriptive agent." }, "timeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "type": "integer", "description": "Per-request timeout in seconds for each GraphQL POST.", "default": 60 } } }, "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 } } } } } } } } } }