Внешнее API отчетов Alytics (версия 2) - История изменений

Elizabeth: /* Доступ к API данных Alytics */

2023-10-17T14:46:29Z

‎Доступ к API данных Alytics

Elizabeth: /* Данные передаваемые через API данных */

2023-05-12T09:50:15Z

‎Данные передаваемые через API данных

Elizabeth в 09:48, 12 мая 2023

2023-05-12T09:48:58Z

Elizabeth в 09:47, 12 мая 2023

2023-05-12T09:47:20Z

Elizabeth: Новая страница: «С помощью нашего API вы сможете использовать статистику отчетов Alytics в своих внешних прил…»

2023-05-12T09:46:36Z

Новая страница: «С помощью нашего API вы сможете использовать статистику отчетов Alytics в своих внешних прил…»

Новая страница

С помощью нашего API вы сможете использовать статистику отчетов Alytics в своих внешних приложениях. В API передаются все показатели трафика и целей, с любой группировкой доступной в Alytics.
В интерфейсе нашего API доступно два метода, которые вы можете использовать при получении статистики отчетов Alytics:
 
- Получение статистики проекта из Alytics,
 
- Получение списка целей:
 
Для API v.1
 
[[Файл:API_methods.png|border|450px]]
 
Для API v.2
 
[[Файл:Api methods2.jpg|border|450px]]
 
При использовании первого метода "Получение статистики проекта из Alytics" будет получена вся информация по проекту: будет передана вся статистика по источникам и информация по всем подключенным целям в проекте. 
 В случае, когда в Вашем проекте имеется большое количество данных и подключенных целей, сначала можно воспользоваться вторым методом "Получение списка целей". Этот метод позволяет получить id подключенных целей в проекте.
 Данные id целей можно выборочно указать в запросе получения статистики проекта и работать уже с ограниченным объемом нужных данных.
Ниже приведена инструкция к доступу и описание данных.
 
 
==Доступ к API данных Alytics==

'''1.''' Перейдите в раздел Инструменты > API данных:

[[Файл:Api_menu.png|border|600px]]

 

'''2.''' На открывшейся странице нажмите кнопку «ПОЛУЧИТЬ КЛЮЧ ДОСТУПА К API»:

[[Файл:Api_key_button.png|border|600px]]

 

'''3.''' Все, теперь вы можете скопировать ключ доступа и использовать наше API в своем приложении.

Передайте разработчикам ключ и ссылку на документацию по API - [https://prod.alytics.ru/external-docs/ ver.1] и [https://prod.alytics.ru/external-docs/v2/ ver.2]:

[[Файл:Api_key_done.png|border|600px]]

'''Обратите внимание:''' ключ открывает доступ к данным определенного проекта и он единый для всех пользователей.

'''Если вы обновите ключ, его необходимо будет заменить в вашем приложении''', иначе доступ перестанет работать.

 
 

==Данные передаваемые через API данных==

Названия полей приведены в документации по API - [https://prod.alytics.ru/external-docs/ ver.1] и [https://prod.alytics.ru/external-docs/v2/ ver.2]:

{| class="wikitable"
! Поле !! Тип данных !! Описание данных
|-
!colspan="3"| '''Поля с параметрами'''
|-
| Дата || Date (YYYYMMDD) || Метка даты для метрик.
|-
| ID проекта || Integer || ID проекта в Alytics.
|-
| Группа источника || Text || Группа источника трафика. Если группы нет то источник / канал.
|-
| Источник / канал || Text || Название источника, равно названию в Алитиксе.
|-
| Кампания || Text || Название кампании источника, равно названию в Алитиксе. Для Маркета — название фида.
|-
| ID кампании || Integer || ID кампании, для кампаний где мы получаем ID.
|-
| Город || Text || Город.
|-
| Регион || Text || Регион.
|-
| Страна || Text || Страна из GA.
|-
!colspan="3"| '''Показатели трафика'''
|-
| Показы || Number || Число показов рекламного сообщения пользователю.
|-
| Клики || Number || Число кликов по рекламным объявлениям.
|-
| Сеансы || Number || Число сеансов привлеченных на сайт.
|-
| Затраты || Number || Сумма расходов на рекламу.
|-
| Цена клика || Number || Средняя стоимость одного клика по рекламе.
|-
| CTR, % || Number || Click-Through Rate - отношение числа кликов к числу показов рекламных объявлений, измеряется в процентах.
|-
| Отказы, % || Number || Процент нецелевых сеансов в ходе которых пользователи покидали сайт сразу после загрузки, не взаимодействуя с ним.
|-
| Время, сек || Number || Средняя продолжительность одного сеанса, измеряется в секундах.
|-
| Стр / сеанс || Number || Среднее число страниц просмотренных в ходе одного сеанса.
|-
| Новые, % || Number || Процент сеансов посетителей которые зашли на сайт впервые за указанный диапазон дат.
|-
!colspan="3"| '''Показатели целей (для каждой цели)'''
|-
| Кол-во || Number || Количество достижений цели, звонков или сделок из CRM.
|-
| Выручка || Number || Выручка от привлеченных продаж.
|-
| Прибыль || Number || Прибыль от привлеченных продаж.
|-
| Чистая прибыль || Number || Чистая прибыль от привлеченных продаж.
|-
| CPA || Number || Cost Per Action – стоимость достижения цели, звонка или сделки из CRM.
|-
| CR, % || Number || Conversion Rate – коэффициент конверсии.
|-
| Средний чек || Number || Средний чек показывает усредненную выручку от одной продажи.
|-
| ROI, % || Number || Return On Investment – показатель окупаемости затрат на рекламу.
|-
| ROAS, % || Number || Return On Advertising Spend – показатель, который измеряет прибыль от размещения рекламы.
|-
| ДРР, % || Number || Доля Рекламных Расходов – отношение вложенных средств к полученной выручке. Формула ДРР = Затраты/Выручка*100%.
|}

@@ Строка 18: / Строка 18: @@
 '''1.''' Перейдите в раздел Инструменты > API данных:
-[[Файл:Api_menu.png|border|600px]]
+[[Файл:Апиданных.png|border|1000px]]
 <br>
@@ Строка 24: / Строка 24: @@
 '''2.''' На открывшейся странице нажмите кнопку «ПОЛУЧИТЬ КЛЮЧ ДОСТУПА К API»:
-[[Файл:Api_key_button.png|border|600px]]
+[[Файл:Api_key_button.png|border|1000px]]
 <br>
@@ Строка 32: / Строка 32: @@
 Передайте разработчикам ключ и ссылку на документацию по API - [https://prod.alytics.ru/external-docs/v2/ ver.2]:
-[[Файл:Api_key_done.png|border|600px]]
+[[Файл:Api_key_done.png|border|1000px]]
 '''Обратите внимание:''' ключ открывает доступ к данным определенного проекта и он единый для всех пользователей.

@@ Строка 43: / Строка 43: @@
 ==Данные передаваемые через API данных==
-Названия полей приведены в документации по API - [https://prod.alytics.ru/external-docs/ ver.1] и [https://prod.alytics.ru/external-docs/v2/ ver.2]:
+Названия полей приведены в документации по API - [https://prod.alytics.ru/external-docs/v2/ ver.2]:
 {| class="wikitable"

@@ Строка 30: / Строка 30: @@
 '''3.''' Все, теперь вы можете скопировать ключ доступа и использовать наше API в своем приложении.
-Передайте разработчикам ключ и ссылку на документацию по API - [https://prod.alytics.ru/external-docs/ ver.1] и [https://prod.alytics.ru/external-docs/v2/ ver.2]:
+Передайте разработчикам ключ и ссылку на документацию по API - [https://prod.alytics.ru/external-docs/v2/ ver.2]:
 [[Файл:Api_key_done.png|border|600px]]

@@ Строка 5: / Строка 5: @@
 <br>
 - Получение списка целей:
 <br><br>
 [[Файл:Api methods2.jpg|border|450px]]