Query

`The query endpoint allows users to execute SQL queries against stored event data. Field names for that can be queried are derived from the schema.

SQL Query Requirements

• Only the events table can be queried.

• PostgreSQL-style placeholders ($1, $2, ...) must be used for parameter substitution.

• Field names in the events table correspond to field names that are defined in the Schema

• Field names should be escaped using backticks (`) .

Example Queries

-- Basic select with timestamp filter
SELECT timestamp, `lr.camera_id`, amount 
FROM events 
WHERE timestamp > $1 AND timestamp < $2

-- Aggregate query
SELECT SUM(amount) 
FROM events 
WHERE timestamp > $1 AND timestamp < $2

-- Grouped aggregation
SELECT pos_id, SUM(amount) 
FROM events 
WHERE timestamp > $1 AND timestamp < $2 
GROUP BY pos_id

Example Request

/query?sql=SELECT+SUM(amount)+FROM+events+WHERE+timestamp+%3E+$1+AND+timestamp+%3C+$2&params[]=2025-01-01T00:00:00Z&params[]=2025-01-31T23:59:59Z

Run an ad‑hoc SQL query

get

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

Format: Api-Key {API_KEY}

Path parameters

namestringRequired

Schema name

Query parameters

sqlstringRequired

SQL statement to execute

params[]string[]Optional

Repeated parameter values bound to positional placeholders in sql

Responses

200

Query results

application/json

get

/schema/{name}/query

HTTPcURLJavaScriptPython

GET /v1/schema/{name}/query?sql=text HTTP/1.1
Host: prism.livereach.ai
Authorization: YOUR_API_KEY
Accept: */*

200

Query results

{
  "result": {
    "success": true,
    "httpCode": 200
  },
  "content": {
    "columns": [
      {
        "name": "text",
        "column_type": "text",
        "data_type": "bool"
      }
    ],
    "rows": [
      [
        "text"
      ]
    ]
  }
}