Media Embed

Embed Session Summary

Changed on

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.

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

Path parameters

embedIdstring required

The _id of the embed, as returned when you create or check an embed. Must be a 24 character hex id.

Query parameters

fromstring date-time

Only sessions started at or after this time, as an ISO 8601 date. Optional. Leave it out for no lower bound.

tostring date-time

Only sessions started at or before this time, as an ISO 8601 date. Optional. Leave it out for no upper bound.

traffic'all' | 'people' | 'bots'

Which visits to count: everyone, only people, or only detected bots and crawlers. Optional. Defaults to all.

includeOwnerboolean

Count visits by members of your own workspace. Optional. Defaults to false.

tzstring

IANA time zone used to group the daily series, such as America/Toronto. Optional. Defaults to UTC. At most 100 characters. An unknown zone returns 400.

mediaPageinteger

Page of the media list to return, starting at 0. Optional. Defaults to 0.

mediaPageSizeinteger

Media files per page, from 1 to 100. Optional. Defaults to 25.

Response

OK

status'success'

Changes