Media Embed

Get Live Embed Sessions

Changed on

How many people are on one embed right now: sessions active in the last minute, sessions still open but idle, and the time of the most recent activity. Legacy visits are never counted. 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}/live

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/embed/sessions/{embedId}/live
  • 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

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.

Response

OK

status'success'

Changes