Technical integration

The Glass Data API is a REST API hosted at https://api.glassdata.io. Integrate the API only through the backend: do not expose the credentials in public clients.

Authentication

The API uses HTTP Basic with credentials generated in API keys. To validate a key already created:

curl https://api.glassdata.io/account -u KEY_ID:KEY_SECRET

Expected response:

{"account":{"id":"0628fd01-038f-7000-9345-4aaefbe9c6b3"}}

Format

Requests with a body (POST, PATCH) must use Content-Type: application/json. Responses also travel in JSON.

Errors

The API returns standard HTTP codes. An error includes the message field with the description of the problem:

{"message":"invalid credentials"}
Code Meaning
400 Invalid request; check the payload
401 Missing or incorrect credentials
403 No permission for this resource
404 Resource not found
422 Valid data but rejected by the platform’s logic
500 Internal error; contact us if it persists
503 Temporarily unavailable; the event was not recorded

On POST /events, the API responds 503 when an internal outage keeps the event type’s rule from deciding, for example when looking up a list or an analysis. The event is not recorded. Resend the event after the interval, in seconds, given in the Retry-After header. Resending does not create a duplicate event.

In other outages, the API responds 201 and holds the event. The event is processed within 10 seconds after the outage ends, and only then appears in Explore.

Platform status

status.glassdata.io publishes availability and the maintenance schedule.

Getting started

  1. Generate an API key in the panel.
  2. Validate the key with the GET /account endpoint.
  3. Register at least one event type with the fields for your use case.
  4. Send occurrences to POST /events providing the event type.
  5. Track the data in the panel under metrics and monitors.

To understand event modeling, see Event type and Event.