SanSignal
Book a demo
Platform guidesAPI reference

Find a guide, feature, or API endpoint. Try “FTP”, “alerts”, or “instruments”.

Search all guides and API endpoints Tab to navigate · Enter to open
Browse documentation

Docs/API reference / Observations

Query observations

Requires `developer_api.instrument_data.query` on the project-scoped Developer API connection. Use the API origin supplied for your deployment. Unknown query parameters and unexpected request bodies are rejected. Time ranges use an inclusive from and exclusive to. Query current raw/corrected observations or current calculated materializations; never treat nil readings as zero. Deployed limits are available from the public OpenAPI metadata endpoint.

GET/dev-api/v1/p/{project_id}/instruments/{instrument_id}/observationsAll endpoints ↗

The request panel saves credentials and API settings in this browser. Privacy details

GET
/dev-api/v1/p/{project_id}/instruments/{instrument_id}/observations

Authorization

developerApiKey
AuthorizationBearer <token>

Project-scoped Developer API connection key. Grant only the required operation permissions.

In: header

Path Parameters

project_id*string
Match.*\S.*
Length1 <= length <= 128
instrument_id*string
Match.*\S.*
Length1 <= length <= 128

Query Parameters

variable_ids*array<>

Comma-separated variable identifiers.

Items1 <= items <= 200
from*string

Start of the requested time range (inclusive). Must be earlier than to.

Formatdate-time
to*string

End of the requested time range (exclusive).

Formatdate-time
quality?array<>

Comma-separated quality values.

Itemsitems <= 16
status?array<>

Comma-separated value statuses.

Itemsitems <= 16
include_nil?boolean

Include observations whose canonical value is nil.

Defaultfalse
include_archived?boolean

Include archived resources explicitly. Archived history still requires authorization.

Defaultfalse
order?string

Observation timestamp order.

Default"asc"

Value in

  • "asc"
  • "desc"
limit?integer

Maximum entries to return. Defaults shown are repository defaults; deployed limits may differ.

Range1 <= value <= 5000
Default1000
cursor?string

Opaque cursor from next_cursor. Keep all filters, resource scope, time range, order, and authorization context unchanged.

Length1 <= length <= 16384

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

bash
curl -X GET "https://example.com/dev-api/v1/p/string/instruments/string/observations?variable_ids=string&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z"
json
{
  "request_id": "string",
  "data": {
    "variables": [
      {
        "instrument_id": "string",
        "instrument_name": "string",
        "instrument_lifecycle_state": "active",
        "id": "string",
        "name": "string",
        "variable_lifecycle_state": "active",
        "value_type": "decimal",
        "unit": "cm"
      }
    ],
    "observations": [
      {
        "instrument_id": "string",
        "variable_id": "string",
        "instrument_timestamp": "2019-08-24T14:15:22Z",
        "value_type": "decimal",
        "decimal_value": 0,
        "string_value": "string",
        "quality": "pass",
        "status": "raw",
        "nil_reason": "string"
      }
    ]
  },
  "next_cursor": "string"
}
SanSignal documentationQuestions? Contact us ↗