Get events schema for a single experiment run

Retrieve the events schema (fields, datasets, mappings) for a single experiment run.

GET /v1/runs/{run_id}/schema

Get events schema for a single experiment run

cURL

curl --request GET \
  --url https://api.dp1.us.honeyhive.ai/v1/runs/{run_id}/schema \
  --header 'Authorization: Bearer <token>'

200

{
  "fields": [
    {
      "name": "<string>",
      "event_type": "<string>"
    }
  ],
  "datasets": [
    "<string>"
  ],
  "mappings": {}
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

run_id · string<uuid> · required

Experiment run ID (UUIDv4)

Query Parameters

dateRange · string object

Filter by date range

Response

200

application/json

Events schema retrieved successfully

Response for GET /events/schema, GET /runs/{run_id}/schema, and GET /runs/schema

fields · object[] · required

Show child attributes

datasets · string[] · required

mappings · object · required

Show child attributes