Внешнее API отчетов Alytics (версия 2)

Материал из Alytics Wiki
Версия от 17:46, 17 октября 2023; Elizabeth (обсуждение | вклад) (Доступ к API данных Alytics)

(разн.) ← Предыдущая | Текущая версия (разн.) | Следующая → (разн.)
Перейти к: навигация, поиск

С помощью нашего API вы сможете использовать статистику отчетов Alytics в своих внешних приложениях. В API передаются все показатели трафика и целей, с любой группировкой доступной в Alytics. В интерфейсе нашего API доступно два метода, которые вы можете использовать при получении статистики отчетов Alytics:
- Получение статистики проекта из Alytics,
- Получение списка целей:

Api methods2.jpg

При использовании первого метода "Получение статистики проекта из Alytics" будет получена вся информация по проекту: будет передана вся статистика по источникам и информация по всем подключенным целям в проекте.

В случае, когда в Вашем проекте имеется большое количество данных и подключенных целей, сначала можно воспользоваться вторым методом "Получение списка целей". Этот метод позволяет получить id подключенных целей в проекте.
Данные id целей можно выборочно указать в запросе получения статистики проекта и работать уже с ограниченным объемом нужных данных. Ниже приведена инструкция к доступу и описание данных.

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

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

Апиданных.png


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

Api key button.png


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

Передайте разработчикам ключ и ссылку на документацию по API - ver.2:

Api key done.png

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

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



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

Названия полей приведены в документации по API - ver.2:

Поле Тип данных Описание данных
Поля с параметрами
Дата Date (YYYYMMDD) Метка даты для метрик.
ID проекта Integer ID проекта в Alytics.
Группа источника Text Группа источника трафика. Если группы нет то источник / канал.
Источник / канал Text Название источника, равно названию в Алитиксе.
Кампания Text Название кампании источника, равно названию в Алитиксе. Для Маркета — название фида.
ID кампании Integer ID кампании, для кампаний где мы получаем ID.
Город Text Город.
Регион Text Регион.
Страна Text Страна из GA.
Показатели трафика
Показы Number Число показов рекламного сообщения пользователю.
Клики Number Число кликов по рекламным объявлениям.
Сеансы Number Число сеансов привлеченных на сайт.
Затраты Number Сумма расходов на рекламу.
Цена клика Number Средняя стоимость одного клика по рекламе.
CTR, % Number Click-Through Rate - отношение числа кликов к числу показов рекламных объявлений, измеряется в процентах.
Отказы, % Number Процент нецелевых сеансов в ходе которых пользователи покидали сайт сразу после загрузки, не взаимодействуя с ним.
Время, сек Number Средняя продолжительность одного сеанса, измеряется в секундах.
Стр / сеанс Number Среднее число страниц просмотренных в ходе одного сеанса.
Новые, % Number Процент сеансов посетителей которые зашли на сайт впервые за указанный диапазон дат.
Показатели целей (для каждой цели)
Кол-во 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%.