1. Документация
  2. Документация API
  3. Объект Stats

Объект Stats

Методы: project | target | session

Статистика по проекту

Получение статистики по проекту.

Входные параметры

Обязательные параметры:

  • String apikey (API ключ)

Необязательные параметры:

  • String project (Выбор проекта) Варианты выбора статистики: all (по всем проектам), Ключ интеграции другого проекта пользователя (по указанному ключу проекта). По умолчанию текущий проект указанного параметра apikey.
  • Date start Дата начала выборки в формате YYYY-MM-DD, например 2020-01-01. Если дата начала не указана, то период определяется как неделя с даты окончания.
  • Date end Дата окончания выборки в формате YYYY-MM-DD, например 2020-05-01. Если дата не указана, то датой окончания является текущая дата.
  • String group (Группировка вывода) Варианты группировки: day (по дням), hour (по часам). По умолчанию day.
  • String order (Сортировка вывода) Варианты сортировки: asc (на увеличение), desc (на уменьшение). По умолчанию asc.
  • Integer page Страница вывода, по молчанию page=1

Пример запроса: 

https://boomstream.com/api/stats?apikey=[API_KEY]&start=2019-01-01&end=2020-05-01&group=day

Пример ответа: 

<Response>
   <Period>01.01.2019 - 10.05.2020</Period>
   <Start>01.01.2019</Start>
   <End>10.05.2020</End>
   <GroupBy>day</GroupBy>
   <SourceType>project</SourceType>
   <Page>1</Page>
   <PageLimit>1000</PageLimit>
   <PageCount>1</PageCount>
   <ItemCount>1</ItemCount>
   <ItemFormat>
      <date>Date</date>
      <time>Time</time>
      <time_dim>Time (hours)</time_dim>
   </ItemFormat>
   <Items>
      <Item>
         <date>23.12.2019</date>
         <time>965600</time>
         <time_dim>0.27 hours</time_dim>
      </Item>
   </Items>
   <Status>Success</Status>
</Response>

Статистика по Видео, Онлайн трансляции и Плейлисту

Получение статистики по Видео, Онлайн трансляции и Плейлисту.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код видео, онлайн трансляции или плейлиста)

Необязательные параметры:

  • Date start Дата начала выборки в формате YYYY-MM-DD, например 2020-01-01. Если дата начала не указана, то период определяется как неделя с даты окончания.
  • Date end Дата окончания выборки в формате YYYY-MM-DD, например 2020-05-01. Если дата не указана, то датой окончания является текущая дата.
  • String group (Группировка вывода) Варианты группировки: day (по дням), hour (по часам). По умолчанию day.
  • String order (Сортировка вывода) Варианты сортировки: asc (на увеличение), desc (на уменьшение). По умолчанию asc.
  • Integer page Страница вывода, по молчанию page=1

Пример запроса: 

https://boomstream.com/api/stats?apikey=[API_KEY]&start=2019-01-01&end=2020-05-01&code=XXXXXXXX&group=day

Пример ответа: 

<Response>
   <Period>01.01.2019 - 10.05.2020</Period>
   <Start>01.01.2019</Start>
   <End>10.05.2020</End>
   <GroupBy>day</GroupBy>
   <SourceType>media</SourceType>
   <Page>1</Page>
   <PageLimit>1000</PageLimit>
   <PageCount>1</PageCount>
   <ItemCount>1</ItemCount>
   <ItemFormat>
      <date>Date</date>
      <time>Time</time>
      <time_dim>Time (hours)</time_dim>
   </ItemFormat>
   <Items>
      <Item>
         <date>23.12.2019</date>
         <time>965600</time>
         <time_dim>0.27 hours</time_dim>
      </Item>
   </Items>
   <Status>Success</Status>
</Response>

Статистика по сессии просмотра

Получение статистики по сессии просмотра конкретного зрителя по паролю.

Входные параметры

Обязательные параметры:

  • String apikey (API ключ)
  • String code (Код медиа)
  • String hash (Пароль доступа)

Необязательные параметры:

  • Date start Дата начала выборки в формате YYYY-MM-DD, например 2020-01-01. Если дата начала не указана, то ей является текущая дата.
  • Date end Дата окончания выборки в формате YYYY-MM-DD, например 2020-05-01. Если дата не указана, то датой окончания является день после текущей даты, т.е. завтра.
  • String order (Сортировка вывода) Варианты сортировки: asc (на увеличение, в алфавитном порядке), desc (на уменьшение). По умолчанию asc.
  • Integer page Страница вывода, по молчанию page=1 (на одной странице может быть 1000 записей).

Выходные параметры

  • String Place (название медиа, к которому привязан пароль доступа)
  • String IP (ip адрес устройства просмотра)
  • String Country (страна устройства просмотра, определяется по ip адресу)
  • String UserAgent (информация о user agent зрителя)
  • Date CreatedAt (время создания сессии)
  • Integer LeftActivations (количество оставшихся активаций пароля)

Пример запроса: 

https://boomstream.com/api/ppv/sessions?apikey=[API_KEY]&code=[media_code]&hash=[customer_password]&start=2019-01-01&end=2020-05-01&order=desc

Пример ответа: 

<Response>
<Item>
   <Place>Media name</Place>
   <ip>192.168.0.1</ip>
   <Country>Russia</Country>
   <UserAgent>Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/84.0.4147.135 Safari/537.36</UserAgent>
   <Start>2020-09-09 11:35:28</Start>
   <LeftActivations>1</LeftActivations>
     </Item>
</Response>