{ "openapi": "3.0.1", "info": { "title": "SensorThings API Extractor", "description": "Point at ANY OGC SensorThings API v1.1 instance (FROST-Server, GOST, SensorUp and thousands of air-quality, smart-city and research deployments) and get flat sensor rows — observations, things with coordinates, datastreams with units — plus raw JSON. @iot.nextLink paging, OData filters. Pay per row.", "version": "0.1", "x-build-id": "015k7g0YxD1D5Qyfv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~sensorthings-api-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-sensorthings-api-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~sensorthings-api-extractor/runs": { "post": { "operationId": "runs-sync-datamule-sensorthings-api-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~sensorthings-api-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-sensorthings-api-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": [ "sources" ], "properties": { "sources": { "title": "SensorThings API URL(s)", "type": "array", "description": "One or more OGC SensorThings API v1.1 base URLs — the endpoint of ANY conforming instance (FROST-Server, GOST, SensorUp, …). A bare base URL is fine; the actor appends the entity-set path (/Things, /Datastreams, /Observations) itself, and a URL ending in an entity set is normalized back to the base. Examples: https://iot.hamburg.de/v1.1 (City of Hamburg), https://airquality-frost.k8s.ilt-dmz.iosb.fraunhofer.de/v1.1 (Fraunhofer IOSB air quality), https://sensorthings.imk-ifu.kit.edu/v1.1 (KIT TERENO). One actor works against every OGC-compliant SensorThings deployment on Earth.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "observations", "things", "datastreams", "discovery" ], "type": "string", "description": "Which entity to harvest. observations (default) returns sensor readings (result + timestamps); things returns the monitored assets with their locations/coordinates; datastreams returns the measurement series (unit of measurement, observed area, phenomenon time) linking a Thing to a Sensor and ObservedProperty; discovery returns one fingerprint row per instance (available entity sets + declared conformance classes + server settings).", "default": "observations" }, "datastreamId": { "title": "Datastream id (observations mode)", "type": "string", "description": "Optional. In observations mode, scope the harvest to a single datastream by fetching /Datastreams({id})/Observations instead of the whole /Observations collection. Get datastream ids by running the actor once in datastreams mode. Leave empty to harvest all observations on the instance." }, "$filter": { "title": "OData $filter", "type": "string", "description": "Optional OData filter passed through verbatim to the SensorThings query, e.g. result gt 0, phenomenonTime gt 2024-01-01T00:00:00Z, name eq 'PM10', or startswith(name,'Air'). Leave empty for no filter. See the OGC SensorThings API v1.1 spec for the full $filter grammar." }, "$expand": { "title": "OData $expand", "type": "string", "description": "Optional OData expand passed through verbatim, e.g. Datastream,FeatureOfInterest on observations, or Sensor,ObservedProperty,Thing on datastreams, to inline related entities. In things mode this defaults to Locations (so each Thing carries its coordinates) unless you override it here." }, "$select": { "title": "OData $select", "type": "string", "description": "Optional OData select passed through verbatim to narrow the fields the server returns, e.g. @iot.id,result,phenomenonTime. Leave empty to return the full entity (the actor always keeps the raw entity in the _raw column)." }, "$orderby": { "title": "OData $orderby", "type": "string", "description": "Optional OData orderby passed through verbatim, e.g. phenomenonTime desc to get the newest observations first. Leave empty for the server default order." }, "maxRecords": { "title": "Max records (global cap)", "minimum": 1, "type": "integer", "description": "A GLOBAL cap on the total number of rows to harvest across all sources and all @iot.nextLink pages (each emitted row is one billable event). Default 1000. Increase to auto-paginate through a large collection; observations collections can be very large, so this is your cost control.", "default": 1000 }, "bearer": { "title": "Bearer token", "type": "string", "description": "Optional bearer token for gated SensorThings deployments (sent as Authorization: Bearer …). Not required for public instances — anonymous read is the norm for the protocol. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers as a JSON object, e.g. {\"x-api-key\": \"...\"} for gated servers. Not required for public instances. Header values are never logged." } } }, "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 } } } } } } } } } }