REST API
Adspect предоставляет REST API для автоматизации различных задач:
Получения статистики: построения воронок продаж и выгрузки логов переходов
Базовым URL для всех точек вызова является https://api.adspect.net/v1/
. Описания точек вызова ниже указывают пути относительно
этого базового URL. Сначала указывается HTTP-метод, за которым следует относительный путь точки вызова, например:
GET /streams
Это описание означает GET-запрос на URL https://api.adspect.net/v1/streams
.
API поддерживает JSON- и XML-кодирование данных. В примерах ниже будет использовано JSON-кодирование для простоты.
Аутентификация
Для аутентификации в API используется HTTP-аутентификация типа Basic, в которой ключ API передается в качестве имени пользователя, а пароль оставляется пустым. Ваш ключ API находится в вашем профиле.
Каждый запрос к API должен содержать два обязательных заголовка:
Заголовок |
Значение |
Описание |
---|---|---|
|
|
Аутентификация в Adspect при помощи ключа API (см. ниже). |
|
|
Выбор JSON- или XML-кодирования данных, соответственно. |
Поле AUTHKEY
в заголовке Authorization формируется путем base64-кодирования строки,
составленной из ключа API и добавленного в конце двоеточия.
Пример кода на PHP:
1<?php
2$apiKey = 'SEbMw152aoe2ArffS7yjEJzJ_MFnd33e';
3$authKey = base64_encode($apiKey . ':');
Совет
Для удобства вы можете взять готовое значение AUTHKEY
в вашем профиле в поле «Заголовок Authorization».
Некоторые HTTP-клиенты имеют нативную поддержку аутентификации HTTP Basic и самостоятельно добавляют заголовок Authorization
.
Например, Python Requests предоставляет класс requests.auth.HTTPBasicAuth
.
В этом случае укажите ваш ключ API в качестве имени пользователя и оставьте пароль пустым. Пример для
php-curl:
<?php
$apiKey = 'SEbMw152aoe2ArffS7yjEJzJ_MFnd33e';
$curl = curl_init();
curl_setopt($curl, CURLOPT_USERPWD, $apiKey . ':');
Коллекции
Некоторые свойства объектов могут принимать значения только из строго заданных множеств — коллекций. В таблице ниже приводятся точки вызова для получения коллекций:
Точка вызова |
Описание |
---|---|
|
Шаблоны потоков (цели использования) для различных источников трафика. |
|
Операционные системы для таргетинга и статистики. |
|
Браузеры для таргетинга и статистики. |
|
Движки браузера для таргетинга и статистики. |
|
Коды стран для таргетинга и статистики. |
|
Коды языков для таргетинга и статистики. |
|
Часовые пояса для таргетинга и статистики. |
|
Режимы потока. |
|
Действия для контента и белой страницы (см. ниже). |
|
Элементы разбивки для воронки продаж. |
|
Колонки метрик воронки продаж. |
|
Колонки лога переходов. |
Действия потока
Следующая таблица описывает действия для контента и белой страницы:
Действие |
Описание |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Управление потоками
Поток представляется в виде объекта со следующими свойствами:
Свойство |
Тип |
Описание |
---|---|---|
|
Строка |
ID потока. |
|
Строка |
ID аккаунта. Только для чтения. |
|
Строка |
Имя потока. |
|
Строка |
Шаблон потока (цель использования). Только для записи. |
|
Массив строк |
Теги, до 32 штук. |
|
Строка |
Режим потока, один из: |
|
Строка |
Любые заметки, которые вы хотели бы записать. |
|
Массив объектов |
Массив контент-страниц, до 254 объектов, каждый со следующими свойствами: |
|
Строка |
Ротатор контент-страниц: |
|
Массив из одного объекта |
Белая страница. Массив из одного объекта со следующими свойствами: |
|
Целое число |
Число первых переходов, которые будут отфильтрованы (отложенный запуск). |
|
Строка |
Режим пропуска переходов, один из: |
|
Целое число или строка |
Уровень фильтрации, один из: |
|
Логический |
Включить фильтрацию по JavaScript-отпечаткам и обучение модели VLA™. |
|
Логический |
Включить фильтрацию по встроенным спискам user agent. |
|
Логический |
Пропускать только уникальных посетителей. |
|
Логический |
Пропускать только устройства с сенсорным экраном. |
|
Логический |
Пропускать трафик из мобильных приложений. |
|
Логический |
Пропускать трафик из фреймов, iframe, элементов embed и object. |
|
Массив строк |
Разрешенные коды стран в двухбуквенном формате. |
|
Массив строк |
Разрешенные операционные системы. |
|
Массив строк |
Разрешенные браузеры. |
|
Массив строк |
Разрешенные движки браузера. |
|
Массив строк |
Разрешенные коды языков браузера. |
|
Логический |
Блокировать переходы без информации о языках браузера. |
|
Строка |
|
|
Строка |
|
|
Строка |
|
|
Строка |
Режим фильтрации, один из: |
|
Логический |
Заносить все IP-адреса в черный список в режиме «Модерация». |
|
Целое число в интервале 0 и 255 |
IPv4-экстраполяция. |
|
Целое число в интервале 0 и 64 |
IPv6-экстраполяция. |
|
Строка |
Режим фильтрации user agent, один из: |
|
Строка или массив строк |
Черный список user agent. |
|
Строка или массив строк |
Белый список user agent. |
|
Строка |
Регулярное выражение для фильтрации по referrer-у. |
|
Массив объектов |
URL-правила. См. структуру объекта URL-правила. |
|
Массив объектов |
Расписание. См. структуру объекта расписания. |
|
Массив целых чисел |
Разрешенные часовые пояса в виде часовых сдвигов относительно UTC. |
|
Логический |
Проверять соответствие часового пояса браузера и местоположения. |
Пример:
{
"stream_id": "1eacc6d0-875f-6f5c-bff8-00162501c2b4",
"account_id": "1eaa2ce5-d4dd-63ec-b8a4-00162501c2b4",
"name": "Example Stream",
"tags": ["Tag1", "Tag2"],
"mode": "Filter",
"notes": "This is an example comment.",
"money_pages": [
{
"page": "https://example.com/offer1?clid={clickid}",
"action": "302",
"arg_passthru": true,
"weight": 10,
"enabled": true
},
{
"page": "https://example.com/offer2?clid={clickid}",
"action": "302",
"arg_passthru": true,
"weight": 20,
"enabled": true
}
],
"rotator": "Split",
"safe_pages": [
{
"page": "safe.html",
"action": "local",
"arg_passthru": true
}
],
"skip_clicks": 30,
"skip_clicks_mode": "all",
"filter_level": "High",
"enable_fp": true,
"enable_ua": true,
"require_unique": true,
"require_touch": false,
"allow_apps": false,
"allow_embed": true,
"countries": ["AE", "HK"],
"os": ["iOS", "macOS"],
"browsers": ["Google Chrome"],
"engines": ["Blink"],
"languages": ["en", "fr", "es"],
"require_language": true,
"sub_id": "{p:utm_campaign}",
"click_id": "{p:gclid}",
"click_cost": "0.15",
"ip_list_mode": "black",
"ip_on_review": true,
"extrapolate_ipv4": 0,
"extrapolate_ipv6": 0,
"ua_list_mode": "black",
"ua_blacklist": [
"^Mozilla/4"
],
"referer_regex": "^(.(?!google[.]))*$",
"url_rules": [
{
"param": "gclid",
"op": "REGEX",
"arg": ".{30,}",
"enabled": true
}
],
"schedule": [
{
"days": ["Sun", "Sat"],
"since": "15:30:00",
"till": "22:15:00"
}
],
"timezones": [-5, -6, -7],
"tz_match_ip": true
}
Объект URL-правила
Объект URL-правила имеет следующую структуру:
{
"param": "gclid",
"op": "REGEX",
"arg": "[[:alnum:]-_]{55,}",
"enabled": true
}
Свойство |
Тип |
Описание |
---|---|---|
|
Строка |
Имя URL-параметра, с которым работает правило. |
|
Строка |
Оператор правила. См. таблицу операторов ниже. |
|
Строка |
Аргумент оператора. См. таблицу операторов ниже. |
|
Логический |
Включает правило. |
Оператор |
Аргумент |
Описание |
---|---|---|
|
Необязательный |
Назначает параметру значение аргумента. |
|
Необязательный |
Меняет имя параметра на значение аргумента. |
|
Игнорируется |
Удаляет параметр. |
|
Игнорируется |
Проверяет, что параметр существует. |
|
Игнорируется |
Проверяет, что параметр не существует. |
|
Необязательный |
Проверяет, что значение параметра совпадает с регулярным выражением в аргументе. |
|
Необязательный |
Проверяет, что значение параметра совпадает с регулярным выражением в аргументе (без учета регистра). |
|
Необязательный |
Проверяет, что значение параметра не совпадает с регулярным выражением в аргументе. |
|
Необязательный |
Проверяет, что значение параметра не совпадает с регулярным выражением в аргументе (без учета регистра). |
|
Необязательный |
Проверяет, что значение параметра равно аргументу. |
|
Необязательный |
Проверяет, что значение параметра не равно аргументу. |
|
Необязательный |
Проверяет, что значение параметра меньше аргумента. |
|
Необязательный |
Проверяет, что значение параметра больше или равно аргументу. |
|
Необязательный |
Проверяет, что значение параметра меньше аргумента. |
|
Необязательный |
Проверяет, что значение параметра меньше или равно аргументу. |
Объект расписания
Объект расписания имеет следующую структуру:
{
"days": ["Sun", "Sat"],
"since": "15:30:00",
"till": "22:15:00"
}
Свойство |
Тип |
Описание |
---|---|---|
|
Массив строк |
Дни недели, к которым относится правило: |
|
Строка |
Пропускать посетителей со времени суток в формате |
|
Строка |
Пропускать посетителей до времени суток в формате |
Список потоков
GET /streams
Эта точка вызова возвращает список потоков в аккаунте. Список разбивается на страницы, а потоки в нем выводятся в возрастающем лексикографическом порядке их имен.
Поддерживаемые URL-параметры:
Параметр |
Тип |
Значение по умолчанию |
Описание |
---|---|---|---|
|
Целое число |
1 |
Номер страницы для отображения. |
|
Целое число от 1 до 100 |
20 |
Число потоков на страницу. |
|
Строка |
Нет |
Выводит только те потоки, в имени которых содержится указанная подстрока (без учета регистра). |
Данные о списке потоков
HEAD /streams
Эта точка вызова возвращает заголовки с общей информацией о числе потоков и страниц:
Заголовок |
Тип |
Описание |
---|---|---|
|
Целое число |
Общее число потоков. |
|
Целое число |
Общее число страниц. |
Поддерживаемые URL-параметры:
Параметр |
Тип |
Значение по умолчанию |
Описание |
---|---|---|---|
|
Целое число от 1 до 100 |
20 |
Число потоков на страницу. |
Получение потока
GET /streams/<ID>
Эта точка вызова возвращает поток <ID>
.
Создание потока
POST /streams
Эта точка вызова создает и возвращает новый поток. Укажите объект потока в теле запроса.
Все свойства объекта потока имеют значения по умолчанию, поэтому вам нужно указывать только те свойства,
значения которых вы хотите задать явно, например {"name":"My Stream"}
.
Обновление потока
PATCH /streams/<ID>
Эта точка вызова обновляет поток <ID>
. Укажите объект потока в в теле запроса.
Вам нужно указать только те свойства, значения которых вы хотите изменить; все остальные свойства
останутся неизменными.
Копирование потока
COPY /streams/<ID>
Эта точка вызова копирует поток <ID>
. Укажите объект потока в теле запроса —
указанные в нем свойства заменят свойства в скопированном потоке, что сэкономит вам дополнительный
вызов точки PATCH
. Если свойства изменять не требуется, то укажите пустой объект {}
.
Удаление потока
DELETE /streams/<ID>
Эта точка вызова удаляет поток <ID>
.
PHP-файлы интеграции
GET /streams/<ID>/file?name=index.php
GET /streams/<ID>/file?name=filter.php
GET /streams/<ID>/file?name=ajax.php
Эта точка вызова возвращает файлы интеграции index.php
, filter.php
и ajax.php
для потока <ID>
.
Гостевой доступ к статистике
Гостевой доступ к статистике позволяет третьим лицам просматривать заранее определенные фрагменты вашей статистики без необходимости входа в систему. Управление гостевым доступом производится при помощи сохраненных запросов:
Создается сохраненный запрос к статистике, в котором указываются параметры выгрузки отчета (даты и фильтры);
В ответ API передает ID сохраненного запроса;
Гость может выполнить этот сохраненный запрос на странице статистики, указав ID сохраненного запроса в соответствующем поле, либо перейдя по ссылке вида
https://clients.adspect.io/reporting?query_id=<ID>
, где вместо<ID>
подставляется ID сохраненного запроса.
Примечание
Можно создавать не более 100 сохраненных запросов.
Сохраненный запрос представляется в виде объекта со следующими свойствами:
Свойство |
Тип |
Описание |
---|---|---|
|
Строка |
ID сохраненного запроса. Только для чтения. |
|
Строка |
ID аккаунта владельца запроса. Только для чтения. |
|
Целое число или строка |
Минимальное Unix-время, начиная с которого выгружается отчет. |
|
Целое число или строка |
Максимальное Unix-время, до которого выгружается отчет. |
|
Строка |
Часовой пояс по умолчанию для отображения дат и времени. |
|
Массив строк |
Разбивка воронки продаж по умолчанию. |
|
Массив строк |
Фильтр по ID потоков. |
|
Массив строк |
Фильтр по IP-адресам. |
|
Массив целых чисел или строк |
Фильтр по номерам автономных систем (ASN). ASN могут быть заданы строками вида |
|
Массив строк |
Фильтр по кодам стран в двухбуквенном формате. |
|
Массив строк |
Фильтр по операционным системам. |
|
Массив строк |
Фильтр по браузерам. |
|
Массив строк |
Фильтр по движкам браузера. |
|
Массив строк |
Фильтр по sub ID. |
|
Массив строк |
Фильтр по ID переходов. |
|
Массив строк |
Фильтр по режимам потока. |
|
Массив целых чисел |
Фильтр по показанным страницам: |
Все поля необязательны. Если тот или иной фильтр не требуется, то его можно не указывать, либо задать значение null
(или пустой массив []
там, где типом значения является массив).
Пример:
{
"query_id": "878efbf1-0fb9-4c69-ad36-40e714b0eeeb",
"owner_id": "1eb5991f-a25b-68f4-b171-00162501c2b4",
"date_from": 1577836800,
"date_to": null,
"time_zone": "Asia/Dubai",
"group_by": [],
"account_id": ["1eb5991f-a25b-68f4-b171-00162501c2b4"],
"stream_id": ["6792f6ce-f153-439f-b223-f58749f1210f"],
"ip_address": [],
"asn": [],
"country_code": ["HK", "AE"],
"os": ["iOS", "macOS"],
"browser": ["Apple Safari"],
"engine": [],
"sub_id": [],
"click_id": [],
"mode": ["Filter"],
"target": []
}
Список запросов
GET /reports
Эта точка вызова возвращает список запросов в аккаунте, разбитый на страницы.
Поддерживаемые URL-параметры:
Параметр |
Тип |
Значение по умолчанию |
Описание |
---|---|---|---|
|
Целое число |
1 |
Номер страницы для отображения. |
|
Целое число от 1 до 100 |
20 |
Число запросов на страницу. |
Данные о списке запросов
HEAD /reports
Эта точка вызова возвращает заголовки с общей информацией о числе запросов и страниц:
Заголовок |
Тип |
Описание |
---|---|---|
|
Целое число |
Общее число запросов. |
|
Целое число |
Общее число страниц. |
Поддерживаемые URL-параметры:
Параметр |
Тип |
Значение по умолчанию |
Описание |
---|---|---|---|
|
Целое число от 1 до 100 |
20 |
Число потоков на страницу. |
Получение запроса
GET /reports/<ID>
Эта точка вызова возвращает сохраненный запрос <ID>
.
Создание запроса
POST /reports
Эта точка вызова создает и возвращает новый запрос. Укажите объект запроса в теле HTTP-запроса.
Обновление запроса
PATCH /reports/<ID>
Эта точка вызова обновляет запрос <ID>
. Укажите объект запроса в теле HTTP-запроса.
Вам нужно указать только те свойства, значения которых вы хотите изменить; все остальные свойства
останутся неизменными.
Копирование запроса
COPY /reports/<ID>
Эта точка вызова копирует запрос <ID>
. Укажите объект запроса в теле HTTP-запроса —
указанные в нем свойства заменят свойства в скопированном запросе, что сэкономит вам дополнительный
вызов точки PATCH
.
Удаление запроса
DELETE /reports/<ID>
Эта точка вызова удаляет запрос <ID>
.
API статистики
API статистики предоставляет вам программный доступ к статистике Adspect через две точки вызова:
Воронка продаж для создания агрегированных отчетов;
Лог переходов для получения сырых данных о кликах и конверсиях.
Они функционально идентичны разделу «Статистика» личного кабинета Adspect.
Фильтры
Обе точки вызова поддерживают фильтры в виде URL-параметров для ограничения выборки статистических данных, например:
date_from=1672520400&date_to=1675198800&country_code[]=AE&os[]=iOS&os[]=macOS
Отчет, сформированный с такими фильтрами, будет содержать только клики и конверсии, отвечающие всем условиям:
за январь 2023 года:
date_from=1672520400&date_to=1675198800
из Объединенных Арабских Эмиратов:
country_code[]=AE
с устройств iOS или macOS:
os[]=iOS&os[]=macOS
Совет
Вы можете указывать дату и время в свободном формате вместо временных меток Unix. Например, 1 Jan 2023
или 2023-01-01
вместо
1672520400
. Adspect постарается максимально точно распарсить такую строку.
Следующая таблица перечисляет доступные параметры фильтров. Все параметры являются необязательными.
Примечание
Параметры, заканчивающиеся на []
, являются массивами: вы можете указать несколько таких параметров, и их значения будут
объединены логическим ИЛИ. Например, фильтр os[]=iOS&os[]=macOS
отберет те клики и конверсии, которые были сделаны с
устройств iOS или macOS.
Параметр |
Тип |
Описание |
---|---|---|
|
Строка |
ID сохраненного запроса для гостевого доступа к статистике других пользователей Adspect. |
|
Целое число или строка |
Минимальное Unix-время, начиная с которого выгружается отчет. |
|
Целое число или строка |
Максимальное Unix-время, до которого выгружается отчет. |
|
Строка |
Часовой пояс для отображения дат и времени, например, |
|
Строка |
Фильтр по ID потоков. |
|
Строка |
Фильтр по IP-адресам. |
|
Целое число или строка |
Фильтр по номерам автономных систем (ASN). ASN могут быть заданы строками вида |
|
Строка |
Фильтр по кодам стран в двухбуквенном формате. |
|
Строка |
Фильтр по операционным системам. |
|
Строка |
Фильтр по браузерам. |
|
Строка |
Фильтр по движкам браузера. |
|
Строка |
Фильтр по sub ID. |
|
Строка |
Фильтр по ID переходов. |
|
Строка |
Фильтр по режимам потока. |
|
Целое число |
Фильтр по показанной странице: |
Воронка продаж
GET /reports/funnel
Эта точка вызова возвращает агрегированный отчет (воронку продаж). Каждая строка отчета является JSON-массивом, порядок элементов
которого соответствует порядку параметров group_by[]
и затем порядку параметров metrics[]
.
Следующая таблица перечисляет URL-параметры, специфичные для точки вызова воронки продаж.
Примечание
Параметры, заканчивающиеся на []
, являются массивами: вы можете указать несколько таких параметров, и их значения будут
объединены. Например, разбивка group_by[]=date&group_by[]=stream_id
сгруппирует воронку сначала по дате, а затем по ID потока.
Аналогично, параметры metrics[]=clicks&metrics[]=money_hits
добавят в отчет колонки числа кликов и переходов на контент в
указанном порядке.
Параметр |
Тип |
Описание |
---|---|---|
|
Строка, необязательный |
Добавляет колонку разбивки в отчет. |
|
Строка, обязательный |
Добавляет колонку метрики в отчет. |
Колонки разбивки воронки продаж
Следующая таблица перечисляет доступные колонки разбивки воронки продаж для URL-параметра group_by[]
.
Колонка |
Описание |
---|---|
|
Дата в формате |
|
Месяц в формате |
|
ID потока. |
|
|
|
|
|
Операционная система. |
|
Браузер. |
|
Движок браузера. |
|
Язык браузера. |
|
|
|
Режим потока в момент перехода. |
|
Показанная страница: |
|
Тег, обозначающий причину блокировки перехода. |
Совет
Этот список можно получить при помощи точки вызова GET /collections/query-group-by
Колонки метрик воронки продаж
Следующая таблица перечисляет доступные колонки метрик воронки продаж для URL-параметра metrics[]
.
Важно
Пожалуйста, указывайте в API-запросе только те метрики, которые вам нужны.
Метрика |
Описание |
---|---|
|
Общее число переходов. |
|
Приблизительное число уникальных посетителей с точки зрения уникальности их IP-адресов. |
|
Число посетителей, которые при обработке успешно сформировали и передали JavaScript-отпечаток. По различным причинам это число может быть меньше, чем общее число переходов, но как правило разницу составляют «тупые» боты, которые не поддерживают JavaScript. |
|
Число показов контент-страницы. |
|
Число уникальных посетителей, которым была показана контент-страница. |
|
Число показов белой страницы. |
|
«General invalid traffic» — число посетителей, заблокированных по поверхностным признакам, таким как IP-адрес, строка user agent, таргетинг и т.п. |
|
«Sophisticated invalid traffic» — число посетителей, заблокированных алгоритмами Adspect на основании их JavaScript-отпечатков. |
|
Число посетителей, которые не смогли сформировать и отправить JavaScript-отпечаток (технические потери). Как упоминалось ранее, это как правило «тупые» боты с ограниченной поддержкой JavaScript. Другая распространенная причина технических потерь — сетевые задержки, особенно наглядные при работе с трафиком с плохим Интернет-соединением типа 3G/EDGE: посетители успевают закрыть окно или вкладку прежде, чем отпечаток будет отправлен. |
|
Процент показов контент-страницы от общего числа кликов. Это наилучший показатель для оценки качества трафика в целом и может быть использован для сравнения различных источников, площадок, спотов и т.п. Особую ценность представляет сбор черных или белых списков площадок на основании их качества. |
|
Расход, считаемый как сумма цен переходов, если они были переданы через параметр ссылки. |
|
Число конверсий. |
|
Коэффициент конверсии = конверсии : клики. |
|
Доход, считаемый как сумма выплат по конверсиям, если они были переданы через postback. |
|
Прибыль или убыток = доход − расход. |
|
Возврат инвестиций = прибыль : расход. |
|
Средняя цена перехода = расход : переходы. |
|
Средняя стоимость тысячи переходов = CPC ∙ 1000. |
|
Средняя цена лида = расход : конверсии. |
|
Средний доход с лида = доход : конверсии. |
|
Средний доход с перехода = доход : переходы. |
|
Средний доход с тысячи переходов = доход : переходы ∙ 1000. |
Совет
Этот список можно получить при помощи точки вызова GET /collections/query-funnel-metrics
Примеры
Пример #1: получение статистики для всех потоков с группировкой по ID потока:
GET /reports/funnel?group_by[]=stream_id&metrics[]=clicks&metrics[]=money_hits&metrics[]=safe_hits&metrics[]=quality
["1ec5880e-bcb6-49b8-9778-a31d22b70708", "1453", "754", "699", 0.5189263592567103]
["07ac03df-268e-41ff-84ba-adfe2241beb2", "3219", "2034", "1125", 0.6318732525629077]
["7a3d39f7-fe75-431e-8be6-9ea9b56b1e4a", "179", "0", "179", 0]
["9f79b75f-20ef-4654-8141-b8bbb2124ec4", "65", "0", "65", 0]
Пример #2: получение статистики по дням для потока с ID 07ac03df-268e-41ff-84ba-adfe2241beb2
:
GET /reports/funnel?group_by[]=date&metrics[]=clicks&metrics[]=money_hits&metrics[]=safe_hits&metrics[]=quality&stream_id[]=07ac03df-268e-41ff-84ba-adfe2241beb2
["2024-04-01", "931", "343", "582", 0.3684210526315789]
["2024-04-02", "1166", "829", "300", 0.7109777015437393]
["2024-04-03", "1113", "855", "243", 0.7681940700808625]
["2024-04-04", "9", "7", "0", 0.7777777777777778]
Лог переходов
GET /reports/log
Эта точка вызова возвращает лог переходов. Каждая строка отчета является JSON-массивом, порядок элементов которого соответствует
порядку параметров columns[]
.
Следующая таблица перечисляет URL-параметры, специфичные для точки вызова лога переходов.
Примечание
Параметры, заканчивающиеся на []
, являются массивами: вы можете указать несколько таких параметров, и их значения будут
объединены. Например, параметры columns[]=timestamp&columns[]=ip_address
добавят в отчет колонки временной метки и IP-адреса в
указанном порядке.
Параметр |
Тип |
Описание |
---|---|---|
|
Строка, обязательный |
Добавляет колонку лога переходов в отчет. |
Колонки лога переходов
Следующая таблица перечисляет доступные колонки лога переходов для URL-параметра columns[]
.
Важно
Пожалуйста, указывайте в API-запросе только те колонки, которые вам нужны.
Колонка |
Описание |
---|---|
|
Дата и время перехода или конверсии. |
|
IP-адрес. |
|
|
|
ID аккаунта. |
|
ID потока. |
|
|
|
Операционная система. |
|
Браузер. |
|
Движок браузера. |
|
Список языков браузера. |
|
Цена перехода или выплата по конверсии. |
|
|
|
|
|
Режим потока в момент перехода. |
|
Этап обработки перехода: |
|
Показанная страница: |
|
Список тегов, обозначающих причины блокировки перехода. |
Совет
Этот список можно получить при помощи точки вызова GET /collections/query-log-columns
Примеры
Получение лога переходов за сегодня для потока с ID 07ac03df-268e-41ff-84ba-adfe2241beb2
:
GET /reports/log?columns[]=timestamp&columns[]=ip_address&columns[]=country_code&columns[]=target&date_from=today&date_to=tomorrow&stream_id[]=07ac03df-268e-41ff-84ba-adfe2241beb2
["2024-04-01 00:00:00", "23.83.90.68", "US", 0]
["2024-04-01 00:00:00", "2a03:2880:30ff:8::33", "SE", 0]
["2024-04-01 00:00:00", "47.128.19.245", "SG", 0]
["2024-04-01 00:00:00", "176.223.109.119", "US", 0]
["2024-04-01 00:00:00", "2a03:2880:20ff:76::33", "US", 0]
["2024-04-01 00:00:00", "89.248.163.208", "NL", 0]
["2024-04-01 00:00:00", "47.128.98.197", "SG", 0]
["2024-04-01 00:00:00", "47.128.25.161", "SG", 0]
["2024-04-01 00:00:00", "95.90.237.130", "DE", 0]
["2024-04-01 00:00:00", "176.5.15.114", "DE", 0]
Информация об аккаунте
GET /account
Эта точка вызова возвращает информацию о вашем аккаунте.
Аккаунт представляется в виде объекта со следующими свойствами:
Свойство |
Тип |
Описание |
---|---|---|
|
Строка |
ID аккаунта. |
|
Строка |
Адрес электронной почты. |
|
Строка |
Имя пользователя в Telegram. |
|
Строка |
Код языка интерфейса. |
|
Строка |
Часовой пояс по умолчанию. |
|
Числовая строка |
Баланс в условных единицах. |
|
Целочисленный |
Unix-время окончания подписки Adspect. |
|
Целочисленный |
Unix-время окончания подписки генератора вайтов Comsign. |
|
Целочисленный |
Тарифный лимит скачиваний вайтов Comsign. |
|
Целочисленный |
Докупленный лимит скачиваний вайтов Comsign. |