---
title: "Embed Session Summary"
method: GET
path: "/embed/sessions/{embedId}/summary"
tags: ["Media Embed"]
---

# Embed Session Summary

`GET /embed/sessions/{embedId}/summary`

## Request

- Base URL: `https://api.speakai.co/v1`
- URL: `https://api.speakai.co/v1/embed/sessions/{embedId}/summary`
- Auth: API key in header `x-speakai-key` and API key in header `x-access-token`

Headline numbers for one embed over a date range: sessions, unique and returning visitors, identified viewers, active time, media opens, watch time and questions, plus a daily series, the top referring sites and a page of per media file numbers.

Legacy visits recorded before session tracking are always included here. Members without access to all folders only see embeds for media and folders they can open. Any other embed, or an embed that is deleted or in another workspace, returns 404.

## Path parameters

- `embedId` string, required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `traffic` 'all' | 'people' | 'bots'
- `includeOwner` boolean
- `tz` string
- `mediaPage` integer
- `mediaPageSize` integer

## Response `200`

OK

- object
  - `status` 'success'
  - `data` object
    - `kpis` object
      - `sessions` integer: Visits in the range. Legacy visits by an identified viewer are not counted again here.
      - `uniqueVisitors` integer: Distinct visitors in the range.
      - `returningVisitors` integer: Visitors with more than one visit in the range, or a visit before it.
      - `identifiedViewers` integer: Distinct viewers who entered an email.
      - `avgActiveMs` integer: Average active time per session, in milliseconds. Legacy visits are left out of the average.
      - `mediaOpens` integer: Media files opened, across all sessions.
      - `watchedMs` integer: Total media playback time, in milliseconds.
      - `questions` integer: Questions asked to the AI chat.
      - `sessionsWithQuestions` integer: Sessions with at least one question.
    - `overTime` object[]: One entry per day that had visits, in the requested time zone. Days with no visits are left out.
      - `date` string: Day as `YYYY-MM-DD`.
      - `sessions` integer
      - `visitors` integer
    - `sources` object[]: Up to 10 referring hosts with the most visits. An empty `source` means no referrer.
      - `source` string
      - `sessions` integer
    - `media` object[]: One page of media files, most opened first.
      - `mediaId` string
      - `name` string: Absent when the media file no longer exists.
      - `durationSec` integer: Absent when unknown.
      - `opens` integer
      - `uniqueViewers` integer
      - `plays` integer
      - `watchedMs` integer: Total playback time for this file, in milliseconds.
      - `avgWatchedMs` integer: Playback time per session that opened this file, in milliseconds.
      - `completionRate` number: Sessions that played this file to the end divided by sessions that opened it, from 0 to 1.
      - `questions` integer: Questions asked about this file.
      - `downloads` integer: Transcript downloads, media downloads and exports for this file.
    - `mediaPage` integer: The media page returned, starting at 0.
    - `mediaPageSize` integer: The media page size used.
    - `mediaTotal` integer: Distinct media files opened in the range, across all pages.

## Other responses

- `400`: A query parameter failed validation
- `404`: Embed not found

## Changes

- **2026-10-19** `52d777e6d46e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/speakai/apis/speak-ai-api/changes/embed/sessions/:embedId/summary/get.md)

---

[API](https://skmtc.dev/speakai/apis/speak-ai-api.md) · [All operations](https://skmtc.dev/speakai/apis/speak-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/speakai/apis/speak-ai-api/revisions/52d777e6d46e?raw)