LogRocket · Schema

HighlightsResult

The generated highlights across all matched sessions.

Session ReplayProduct AnalyticsFrontend MonitoringLoggingErrors

Properties

Name Type Description
highlights string Markdown-formatted summary across all sessions, with links to relevant times in the referenced sessions.
sessions array Individual session summaries.
View JSON Schema on GitHub

JSON Schema

logrocket-highlightsresult-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/HighlightsResult",
  "title": "HighlightsResult",
  "type": "object",
  "description": "The generated highlights across all matched sessions.",
  "properties": {
    "highlights": {
      "type": "string",
      "description": "Markdown-formatted summary across all sessions, with links to relevant times in the referenced sessions."
    },
    "sessions": {
      "type": "array",
      "description": "Individual session summaries.",
      "items": {
        "$ref": "#/components/schemas/SessionHighlight"
      }
    }
  }
}