{ "openapi": "3.0.1", "info": { "title": "OHDSI WebAPI Extractor", "description": "Point at ANY OHDSI WebAPI (the OMOP-CDM / ATLAS analytics REST API) and pull server info, data sources & daimons, saved cohort definitions, concept sets, and OMOP vocabulary concept search into clean flat rows. One generic runner for any observational-health host. Pay per record.", "version": "0.1", "x-build-id": "QSIVGYMKsasK4vFOf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~ohdsi-webapi-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-ohdsi-webapi-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~ohdsi-webapi-extractor/runs": { "post": { "operationId": "runs-sync-datamule-ohdsi-webapi-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~ohdsi-webapi-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-ohdsi-webapi-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": [ "baseUrl" ], "properties": { "baseUrl": { "title": "OHDSI WebAPI root URL(s)", "type": "array", "description": "One or more OHDSI WebAPI ROOT URLs. Examples: https://atlas-demo.ohdsi.org/WebAPI (OHDSI public reference) and https://atlas-covid19.ohdsi.org/WebAPI (COVID-19 network). Point at the WebAPI ROOT — the actor appends /info, /source/sources, /cohortdefinition, /conceptset, /vocabulary/... for you. The root path VARIES per host (some mount at /WebAPI, some behind a proxy at /atlas/WebAPI) so give the full base; do NOT append an endpoint.", "items": { "type": "string" } }, "mode": { "title": "Mode (what to extract)", "enum": [ "sources", "info", "cohortdefinitions", "conceptsets", "vocabulary-search" ], "type": "string", "description": "Which part of the WebAPI to harvest. 'sources' lists the configured OMOP data sources with their daimons. 'info' returns the server version/build/config. 'cohortdefinitions' lists saved cohort (phenotype) definitions. 'conceptsets' lists saved concept sets. 'vocabulary-search' searches OMOP concepts for a term (needs a search term; a sourceKey with a Vocabulary daimon is auto-discovered if you don't supply one).", "default": "sources" }, "query": { "title": "Search term (vocabulary-search mode)", "type": "string", "description": "For 'vocabulary-search' mode: the OMOP concept search term, e.g. 'aspirin', 'type 2 diabetes', 'myocardial infarction'. Matched against concept names across the source's vocabulary. Required for vocabulary-search; ignored in other modes." }, "sourceKey": { "title": "Source key (vocabulary-search mode, optional)", "type": "string", "description": "For 'vocabulary-search' mode: the WebAPI sourceKey whose Vocabulary daimon to search (e.g. SYNPUF5PCT on the OHDSI demo). Leave empty and the actor auto-discovers the first source that owns a Vocabulary daimon from /source/sources. Use 'sources' mode first to see the available keys." }, "maxRecords": { "title": "Max records (total)", "minimum": 1, "type": "integer", "description": "Maximum total rows to emit across all hosts. Vocabulary search can return tens of thousands of concepts, so this caps the run. Each emitted row is one billable event. Default 1000.", "default": 1000 }, "bearerToken": { "title": "Bearer token (optional)", "type": "string", "description": "Optional OAuth2 bearer token for a WebAPI host that has security enabled. Sent as Authorization: Bearer ***. NOT required for the public OHDSI reference servers — leave empty. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers to send with every request, as a JSON object (e.g. an API-key header a specific deployment requires). Leave empty for the public reference servers." } } }, "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 } } } } } } } } } }