Highlight (highlight.io)

aid: highlight-io
url: https://raw.githubusercontent.com/api-evangelist/highlight-io/refs/heads/main/apis.yml
apis:
- aid: highlight-io:highlight-otlp-traces-api
  name: Highlight OTLP Traces API
  tags:
  - Observability
  - OpenTelemetry
  - Traces
  - Tracing
  - Distributed Tracing
  humanURL: https://www.highlight.io/docs/general/product-features/tracing
  properties:
  - url: https://www.highlight.io/docs/general/product-features/tracing
    type: Documentation
  - url: openapi/highlight-otlp-traces-api-openapi.yml
    type: OpenAPI
  - url: json-schema/highlight-trace-schema.json
    type: JSONSchema
  description: >-
    Native OpenTelemetry Protocol (OTLP) HTTP/JSON ingestion endpoint for distributed traces. Accepts standard OTLP
    `ResourceSpans` payloads at `https://otel.highlight.io/v1/traces`. Spans carry the `highlight.project_id` resource
    attribute and optional `highlight.session_id` / `highlight.trace_id` so server-side spans correlate with frontend
    session replay.
- aid: highlight-io:highlight-otlp-logs-api
  name: Highlight OTLP Logs API
  tags:
  - Observability
  - OpenTelemetry
  - Logs
  - Logging
  humanURL: https://www.highlight.io/docs/general/product-features/logging
  properties:
  - url: https://www.highlight.io/docs/general/product-features/logging
    type: Documentation
  - url: openapi/highlight-otlp-logs-api-openapi.yml
    type: OpenAPI
  - url: json-schema/highlight-log-schema.json
    type: JSONSchema
  description: >-
    Native OpenTelemetry Protocol (OTLP) HTTP/JSON ingestion endpoint for structured logs at
    `https://otel.highlight.io/v1/logs`. Supports severity levels, trace/span correlation, and arbitrary attributes.
    Highlight stores logs in ClickHouse for sub-second full-text search and pattern detection.
- aid: highlight-io:highlight-otlp-metrics-api
  name: Highlight OTLP Metrics API
  tags:
  - Observability
  - OpenTelemetry
  - Metrics
  - Beta
  humanURL: https://www.highlight.io/docs/general/product-features/metrics
  properties:
  - url: https://www.highlight.io/docs/general/product-features/metrics
    type: Documentation
  - url: openapi/highlight-otlp-metrics-api-openapi.yml
    type: OpenAPI
  description: >-
    Beta OpenTelemetry Protocol (OTLP) HTTP/JSON ingestion endpoint for metrics at
    `https://otel.highlight.io/v1/metrics`. Accepts gauges, sums, histograms, and exponential histograms and drives
    Highlight dashboards, alerts, and the metrics SQL editor.
- aid: highlight-io:highlight-session-ingestion-api
  name: Highlight Session Ingestion API
  tags:
  - Observability
  - Session Replay
  - Ingestion
  - GraphQL
  humanURL: https://www.highlight.io/docs/general/product-features/session-replay
  properties:
  - url: https://www.highlight.io/docs/general/product-features/session-replay
    type: Documentation
  - url: openapi/highlight-session-ingestion-api-openapi.yml
    type: OpenAPI
  - url: json-schema/highlight-session-schema.json
    type: JSONSchema
  - url: graphql/highlight-io-graphql.md
    type: GraphQL
  description: >-
    GraphQL-over-HTTP session replay ingestion endpoint at `https://pub.highlight.io` used by the `highlight.run`
    browser SDK to upload rrweb DOM snapshots, console/network recording, custom events, identify payloads, and error
    reports. Public, project-id authenticated, no user secrets required.
- 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.
- aid: highlight-io:highlight-webhooks-api
  name: Highlight Webhooks API
  tags:
  - Observability
  - Webhooks
  - Alerts
  - Notifications
  humanURL: https://www.highlight.io/docs/general/product-features/general-features/webhooks
  properties:
  - url: https://www.highlight.io/docs/general/product-features/general-features/webhooks
    type: Documentation
  - url: openapi/highlight-webhooks-api-openapi.yml
    type: AsyncEvents
  description: >-
    Outbound webhooks delivered when Highlight alerts fire. POST JSON payload to a customer-supplied URL with alert
    metadata (name, type, count), error/session/log/metric context, project routing, and action URLs to resolve,
    ignore, or snooze. Supports Error, Session, User, Log, Trace, and Metric monitor alerts.
- aid: highlight-io:highlight-self-hosted-api
  name: Highlight Self-Hosted Deployment
  tags:
  - Observability
  - Self-Hosted
  - Open Source
  - Docker
  - Kubernetes
  humanURL: https://www.highlight.io/docs/general/company/open-source/self-host-hobby
  properties:
  - url: https://www.highlight.io/docs/general/company/open-source/self-host-hobby
    type: Documentation
  - url: https://www.highlight.io/docs/general/company/open-source/self-host-enterprise
    type: Documentation
  - url: https://github.com/highlight/highlight/tree/main/docker
    type: SourceCode
  description: >-
    Self-hosted deployment of the open-source Highlight stack. Three tiers — Dev (single-host docker-compose), Hobby
    (single-host Docker for low-volume production), and Enterprise (Kubernetes with horizontal scaling, ClickHouse
    cluster, and managed retention). All ingestion endpoints (OTLP traces, logs, metrics; pub.highlight.io session
    ingestion; pri.highlight.io GraphQL) are reproduced in-cluster.
name: Highlight (highlight.io)
tags:
- Observability
- Session Replay
- Error Monitoring
- APM
- Logging
- Tracing
- OpenTelemetry
- Open Source
- Frontend Monitoring
- Full Stack Monitoring
kind: contract
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/apis-json-logo.jpg
access: 3rd-Party
x-type: company
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/highlight-highlightio/overview
- type: ArazzoWorkflows
  url: arazzo/
  workflows:
  - url: arazzo/highlight-io-backend-error-report-workflow.yml
    name: Highlight Backend Error Report
    summary: >-
      Record a backend error as an OTLP error span and a matching error log so Highlight groups it into an error
      group.
  - url: arazzo/highlight-io-backend-session-payload-workflow.yml
    name: Highlight Backend Session Payload
    summary: Mark the backend as set up for a project, then push backend errors and logs against a session secure id.
  - url: arazzo/highlight-io-browser-session-lifecycle-workflow.yml
    name: Highlight Browser Session Lifecycle
    summary: >-
      Initialize a browser session, identify its user, then push a recording payload using the returned session
      secure id.
  - url: arazzo/highlight-io-correlated-backend-telemetry-export-workflow.yml
    name: Highlight Correlated Backend Telemetry Export
    summary: >-
      Export traces, then logs, then metrics for the same project and trace so backend signals correlate in
      Highlight.
  - url: arazzo/highlight-io-frontend-error-capture-workflow.yml
    name: Highlight Frontend Error Capture
    summary: Open a browser session and push a payload of frontend errors so Highlight groups them against the replay.
  - url: arazzo/highlight-io-fullstack-error-correlation-workflow.yml
    name: Highlight Fullstack Error Correlation
    summary: >-
      Open a session, push a frontend error, then push a backend error keyed to the same session so both group
      against one replay.
  - url: arazzo/highlight-io-fullstack-session-correlation-workflow.yml
    name: Highlight Fullstack Session Correlation
    summary: >-
      Open a browser session, then emit a backend OTLP span tagged with that session id so frontend replay and
      backend trace correlate.
  - url: arazzo/highlight-io-logs-and-metrics-batch-workflow.yml
    name: Highlight Logs and Metrics Batch
    summary: Submit a batch of OTLP logs and then a batch of OTLP metrics for the same Highlight project in one pass.
  - url: arazzo/highlight-io-session-feedback-capture-workflow.yml
    name: Highlight Session Feedback Capture
    summary: Open a session, attach searchable session properties, then record end-user feedback against that session.
  - url: arazzo/highlight-io-session-track-event-workflow.yml
    name: Highlight Session Track Event
    summary: Open a session, attach track-event properties to it, then flush a recording payload.
- url: https://www.highlight.io
  type: Portal
- url: https://www.highlight.io/docs
  name: Highlight Docs
  type: Documentation
- url: https://www.highlight.io/docs/general/welcome
  name: Welcome to Highlight
  type: GettingStarted
- url: https://app.highlight.io/sign_up
  name: Highlight App Sign-Up
  type: SignUp
- url: https://app.highlight.io
  name: Highlight App
  type: Portal
- url: https://www.highlight.io/pricing
  name: Pricing
  type: Pricing
- url: https://www.highlight.io/customers
  name: Customers
  type: CaseStudies
- url: https://www.highlight.io/blog
  name: Blog
  type: Blog
- url: https://www.highlight.io/changelog
  name: Changelog
  type: ChangeLog
- url: https://status.highlight.io
  name: Status Page
  type: StatusPage
- url: https://www.highlight.io/community
  name: Community
  type: Forum
- url: https://discord.gg/yxaXEAqgwN
  name: Discord
  type: Forum
- url: https://github.com/highlight/highlight
  name: Highlight GitHub Repository
  type: SourceCode
- url: https://github.com/highlight
  name: Highlight GitHub Organization
  type: GitHubOrganization
- url: https://www.highlight.io/docs/general/company/open-source/hosted-vs-self-hosted
  name: Hosted vs Self-Hosted
  type: Documentation
- url: https://www.highlight.io/docs/general/company/open-source/self-host-hobby
  name: Self-Host (Hobby)
  type: Documentation
- url: https://www.highlight.io/docs/general/company/open-source/self-host-enterprise
  name: Self-Host (Enterprise)
  type: Documentation
- url: https://www.highlight.io/docs/general/company/security-and-privacy/compliance
  name: Compliance
  type: Compliance
- url: https://www.highlight.io/docs/general/company/security-and-privacy/security
  name: Security
  type: Security
- url: https://www.highlight.io/terms
  name: Terms of Service
  type: TermsOfService
- url: https://www.highlight.io/privacy
  name: Privacy Policy
  type: PrivacyPolicy
- url: https://www.highlight.io/docs/general/company/general/roadmap
  name: Roadmap
  type: Roadmap
- url: https://www.highlight.io/docs/general/company/open-source/contributing
  name: Contributing Guide
  type: Documentation
- url: https://www.highlight.io/docs/sdk/highlightrun
  name: highlight.run (Browser SDK)
  type: SDK
- url: https://www.npmjs.com/package/highlight.run
  name: highlight.run on npm
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/node
  name: '@highlight-run/node'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/next
  name: '@highlight-run/next'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/nest
  name: '@highlight-run/nest'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/react
  name: '@highlight-run/react'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/remix
  name: '@highlight-run/remix'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/sveltekit
  name: '@highlight-run/sveltekit'
  type: SDK
- url: https://www.npmjs.com/package/@highlight-run/cloudflare
  name: '@highlight-run/cloudflare'
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-go
  name: Go SDK
  type: SDK
- url: https://pypi.org/project/highlight-io/
  name: Python SDK
  type: SDK
- url: https://rubygems.org/gems/highlight_io
  name: Ruby SDK
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-rust
  name: Rust SDK
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-elixir
  name: Elixir SDK
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-java
  name: Java SDK
  type: SDK
- url: https://github.com/highlight/highlight-php
  name: PHP SDK
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-dotnet
  name: .NET SDK
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-react-native
  name: React Native SDK (beta)
  type: SDK
- url: https://github.com/highlight/highlight/tree/main/sdk/highlight-electron
  name: Electron SDK
  type: SDK
- url: openapi/highlight-otlp-traces-api-openapi.yml
  name: OTLP Traces OpenAPI
  type: OpenAPI
- url: openapi/highlight-otlp-logs-api-openapi.yml
  name: OTLP Logs OpenAPI
  type: OpenAPI
- url: openapi/highlight-otlp-metrics-api-openapi.yml
  name: OTLP Metrics OpenAPI
  type: OpenAPI
- url: openapi/highlight-session-ingestion-api-openapi.yml
  name: Session Ingestion OpenAPI
  type: OpenAPI
- url: openapi/highlight-webhooks-api-openapi.yml
  name: Webhooks OpenAPI
  type: OpenAPI
- url: plans/highlight-io-plans-pricing.yml
  type: Plans
- url: rate-limits/highlight-io-rate-limits.yml
  type: RateLimits
- url: finops/highlight-io-finops.yml
  type: FinOps
- url: json-ld/highlight-io-context.jsonld
  type: JSONLD
- url: vocabulary/highlight-io-vocabulary.yml
  type: Vocabulary
- url: rules/highlight-io-rules.yml
  type: SpectralRules
- type: LinkedIn
  url: https://www.linkedin.com/company/highlightio
- type: Twitter
  url: https://twitter.com/highlightio
- type: YouTube
  url: https://www.youtube.com/@highlightio
- type: Features
  data:
  - Session replay built on rrweb with canvas, iframe, and cross-origin support
  - Error monitoring with custom grouping, GitHub-issue linking, sourcemap support, and alerting
  - Logging with full-text search, pattern detection, and ClickHouse-backed sub-second queries
  - Distributed tracing with OpenTelemetry-native ingestion and waterfall visualization
  - Metrics (beta) with dashboards, monitors, and SQL editor
  - Native OTLP HTTP/JSON ingestion at otel.highlight.io for traces, logs, and metrics
  - Frontend correlation — server spans/logs join the originating browser session via highlight.session_id
  - AI-generated session insights and weekly digests
  - Webhook destinations for alerts (Error, Session, User, Log, Trace, Metric monitors)
  - >-
    25+ first-party integrations including Slack, Discord, Microsoft Teams, GitHub, Jira, Linear, ClickUp, Vercel,
    LaunchDarkly, Grafana, Amplitude, Mixpanel, Segment
  - Browser SDKs for React, Next.js, Remix, Vue, Angular, Gatsby, SvelteKit, Electron, React Native (beta)
  - Server SDKs for Node.js, Python, Go, Ruby, Rust, Elixir, Java, PHP, C# .NET
  - Hosting provider SDKs for AWS Lambda, Cloudflare Workers, Vercel, Firebase, Azure Functions, GCP
  - Privacy controls (`privacySetting: strict | default | none`) with PII redaction
  - >-
    100% open source under Apache 2.0 (with separate commercial license for `highlight.io/` and `enterprise/`
    directories)
  - Self-hostable in three tiers — Dev (docker-compose), Hobby (single-host Docker), Enterprise (Kubernetes)
  - Powered by ClickHouse, Kafka, OpenTelemetry Collector, and Postgres
  - SOC 2 Type II, HIPAA, and ISO 27001 attestations available on the hosted offering
  - 9,000+ GitHub stars; active CNCF-style community with 200+ contributors
  sources:
  - https://www.highlight.io
  - https://www.highlight.io/docs
  - https://www.highlight.io/pricing
  - https://github.com/highlight/highlight
  updated: '2026-05-25'
created: '2026-05-25T00:00:00.000Z'
modified: '2026-05-25'
position: Consuming
description: >-
  Highlight (highlight.io) is the open-source, full-stack monitoring platform — session replay, error monitoring,
  logging, distributed tracing, and metrics in a single tool. Built on OpenTelemetry, rrweb, and ClickHouse, Highlight
  correlates server-side spans and logs back to the originating browser session so engineers can move from a customer
  report to the exact line of code in one click. Available as a hosted SaaS on three commercial tiers (Free /
  Pay-as-you-go / Business / Enterprise) and as a fully open-source self-hosted deployment (Dev / Hobby / Enterprise)
  under Apache 2.0.
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com
  X: apievangelist
  url: https://apievangelist.com