Media Embed

List Embed Session Countries

Changed on

Count sessions by country for one embed, most sessions first. Sessions with no known country are left out. Use a returned country value as the country filter on the session list. 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}/countries

Request

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

includeLegacyboolean

Include visits recorded before session tracking, which carry no timing, media or question numbers. Optional. Defaults to false.

Response

OK

status'success'

Changes