Highlight (highlight.io)

Highlight Private GraphQL API

Internal GraphQL API that powers the Highlight dashboard at `https://pri.highlight.io`. Used to list, search, and manage workspaces, projects, sessions, errors, logs, traces, dashboards, alerts, and integrations. Authenticated via dashboard session cookie or workspace admin API token; the schema is open-source under `backend/private-graph/graph` but is not a stable public contract.

Documentation GitHub

Documentation

https://github.com/highlight/highlight/tree/main/backend/private-graph

https://www.highlight.io/docs/general/product-features/general-features/api

Other Resources

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/apis.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-backend-error-report-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-backend-session-payload-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-browser-session-lifecycle-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-correlated-backend-telemetry-export-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-frontend-error-capture-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-fullstack-error-correlation-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-fullstack-session-correlation-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-logs-and-metrics-batch-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-session-feedback-capture-workflow.yml

https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/arazzo/highlight-io-session-track-event-workflow.yml

API entry from apis.yml

aid: highlight-io:highlight-private-graphql-api
name: Highlight Private GraphQL API
tags:
- Observability
- GraphQL
- Management
- Internal
humanURL: https://github.com/highlight/highlight/tree/main/backend/private-graph
properties:
- url: https://github.com/highlight/highlight/tree/main/backend/private-graph
  type: Documentation
- url: https://www.highlight.io/docs/general/product-features/general-features/api
  type: Documentation
description: Internal GraphQL API that powers the Highlight dashboard at `https://pri.highlight.io`. Used
  to list, search, and manage workspaces, projects, sessions, errors, logs, traces, dashboards, alerts,
  and integrations. Authenticated via dashboard session cookie or workspace admin API token; the schema
  is open-source under `backend/private-graph/graph` but is not a stable public contract.