OneAnalytics docs

API reference

OneAnalytics REST API v0.1.0. Generated from the OpenAPI spec on every docs build.

Conventions

  • URI versioning under /v1/.
  • Cursor-only pagination — see Pagination.
  • Errors as RFC 7807 application/problem+json — see Errors.
  • Idempotency via the Idempotency-Key header on POSTs.

System

GET /healthz — Liveness

Example

curl -X GET 'https://api.analytics.rstglobal.in/healthz' \
  -H 'Authorization: Bearer $OA_TOKEN'

Response — OK

GET /api/config/public — Public runtime configuration

Read by the frontend at boot; returns URLs, branding, features.

Example

curl -X GET 'https://api.analytics.rstglobal.in/api/config/public' \
  -H 'Authorization: Bearer $OA_TOKEN'

Response — OK

Workspaces

GET /v1/workspaces — List workspaces

Parameters

  • #/components/parameters/Limit
  • #/components/parameters/Cursor

Example

curl -X GET 'https://api.analytics.rstglobal.in/v1/workspaces' \
  -H 'Authorization: Bearer $OA_TOKEN'

Response — OK

POST /v1/workspaces — Create a workspace

Parameters

  • #/components/parameters/IdempotencyKey

Example

curl -X POST 'https://api.analytics.rstglobal.in/v1/workspaces' \
  -H 'Authorization: Bearer $OA_TOKEN' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response — Created

Datasets

GET /v1/datasets — List datasets in the current tenant

Parameters

  • workspace_id in query (required)
  • #/components/parameters/Limit
  • #/components/parameters/Cursor

Example

curl -X GET 'https://api.analytics.rstglobal.in/v1/datasets' \
  -H 'Authorization: Bearer $OA_TOKEN'

Response — OK

POST /v1/datasets/{id}/query — Execute a semantic query against a dataset

Parameters

  • id in path (required)

Example

curl -X POST 'https://api.analytics.rstglobal.in/v1/datasets/{id}/query' \
  -H 'Authorization: Bearer $OA_TOKEN' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response — Results

Reports

POST /v1/reports/{id}/export — Request an export

Parameters

  • id in path (required)
  • #/components/parameters/IdempotencyKey

Example

curl -X POST 'https://api.analytics.rstglobal.in/v1/reports/{id}/export' \
  -H 'Authorization: Bearer $OA_TOKEN' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response — Accepted — job created

Sharing

POST /v1/sharing/grants — Create a sharing grant

Parameters

  • #/components/parameters/IdempotencyKey

Example

curl -X POST 'https://api.analytics.rstglobal.in/v1/sharing/grants' \
  -H 'Authorization: Bearer $OA_TOKEN' \
  -H 'Idempotency-Key: $(uuidgen)' \
  -H 'Content-Type: application/json' \
  -d '{}'

Response — Created