Get engagement transcript timeline | AskElephant

{
  "object": "transcript_timeline",
  "engagement_id": "string",
  "speakers": [
    {
      "id": "string",
      "type": "contact",
      "first_name": "string",
      "last_name": "string",
      "email": "string",
      "phone": "string",
      "speaking_percentage": 1.1,
      "sentiment": 1.1
    }
  ],
  "entries": [
    {
      "speaker": {
        "type": "contact",
        "id": "string",
        "name": "string"
      },
      "text": "string",
      "start_seconds": 1.1,
      "end_seconds": 1.1,
      "num_words": 1,
      "sentences": [
        {
          "text": "string",
          "start_seconds": 1.1,
          "end_seconds": 1.1
        }
      ]
    }
  ],
  "overall_sentiment": 1.1
}

Returns transcript timeline entries for a workspace engagement. This operation requires the transcript_timelines:read scope. Reading the transcript timeline for a private engagement also requires engagements:read and engagements:private:read.

Authentication

AuthorizationBearer

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

Path parameters

engagement_idstringRequired

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger

Number of requests remaining in the current window before the limit is exceeded.

X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

X-Api-VersionstringOptional

Response

Transcript timeline response.

objectenum

engagement_idstringformat: "^ngmt_[A-Za-z0-9]+$"

speakerslist of objects

Speaker details indexed by their position in the entries.

entrieslist of objects

overall_sentimentdouble or nullOptional

Average sentiment score across all speakers. Null when no sentiment data is available.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error