Fetch summary of transcripts for a session

client.realtimeKit.sessions.getSessionSummary(, , , ?): SessionGetSessionSummaryResponse { data, success }

GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/{session_id}/summary

Returns a Summary URL to download the Summary of Transcripts for the session ID as plain text.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Accepted Permissions (at least one required)

Realtime AdminRealtime

ParametersExpand Collapse

appId: string

The app identifier tag.

maxLength32

sessionId: string

formatuuid

params: SessionGetSessionSummaryParams { account_id }

account_id: string

The account identifier tag.

maxLength32

ReturnsExpand Collapse

SessionGetSessionSummaryResponse { data, success }

data?: Data { sessionId, summaryDownloadUrl, summaryDownloadUrlExpiry }

sessionId: string

summaryDownloadUrl: string

URL where the summary of transcripts can be downloaded

summaryDownloadUrlExpiry: string

Time of Expiry before when you need to download the csv file.

success?: boolean

Fetch summary of transcripts for a session

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const response = await client.realtimeKit.sessions.getSessionSummary(
  'app_id',
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
  { account_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(response.data);

{
  "data": {
    "sessionId": "sessionId",
    "summaryDownloadUrl": "summaryDownloadUrl",
    "summaryDownloadUrlExpiry": "summaryDownloadUrlExpiry"
  },
  "success": true
}

Returns Examples

{
  "data": {
    "sessionId": "sessionId",
    "summaryDownloadUrl": "summaryDownloadUrl",
    "summaryDownloadUrlExpiry": "summaryDownloadUrlExpiry"
  },
  "success": true
}