Работа со статистикой

Статистика

INFO

POST report/tgview

Пример использования:

https://client.adstat.pro/api/report/tgview

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

• Authorization: "Bearer <access_token>"

В тело(body) HTTP запроса необходимо передать параметры получения статистики.

Описание параметров передаваемых в тело запроса:

Поле	Тип	Описание
date	Объект	Интервал дат, определяющий временной период запроса.
date.date_from	Строка	Начальная дата и время в формате ISO 8601 (например, "2024-06-07T00:00:00.000Z").
date.date_to	Строка	Конечная дата и время в формате ISO 8601 (например, "2024-06-07T23:59:59.000Z").
platform	Массив чисел	Статичное значение равное всегда [10].
partner	Массив чисел	Статичное значение равное всегда [2].
campaign	Массив	Список идентификаторов кампаний. Может быть пустым массивом, если нужно получить данные по всем кампаний.
group_time	Число	Параметр группировки по времени. Значения: День- 1, Месяц - 2, Неделя - 3, Год - 4.
groupings	Массив объектов	Список объектов группировки данных. Каждый объект определяет параметр группировки.
groupings.name	Строка	Имя параметра для группировки (например, "date", "object" итд ).
groupings.type	Число	Тип группировки для параметра. Используется только для некоторых группировок (например, 1).
object	Массив	Список идентификаторов объектов рекламирования для плучения статистики по выбранным объектам. ["t.me/someobject", "..."]. Если нужно получить по всем объектам, то значение - []. Список объектов рекламирования можно получить в Список объектов рекламирования
sub_client	Массив	Внутренний параметр для технических нужд.
type_cab	null	Тип кабинета. Статичное значение - всегда null.
currency	Строка	Валюта, в которой будут представлены данные. Статичное значение - всегда RUB
account_uids	Массив	Список идентификаторов кабинетов, предназначенный для фильтрации статистики по отдельным кабинетам.Может быть пустым массивом [], если нужно получить данные по всем кабинетам. Если по отдельным кабинетам - ["ACC0000", "..."]. Список содержащий account_uids кабинетов можно получить в Список кабинетов

Подробное описание и примеры использования параметров в теле запроса:

groupings :

• Значение, когда необходимо получить статистику сгруппированную только по дате:

{
  "others_params": "others params",
  "groupings": [{ "name": "date", "type": "<group_time>" }],
  "..": "others params"
}

• Значение, когда необходимо получить статистику сгрупированную по -

Объекту рекламирования - {"name": "object"},

По объявлению - {"name": "campaign"},

По кабинету - {"name": "account", "type": 1}

{
  "others_params": "others params",
  "groupings": [
    { "name": "object" },
    { "name": "campaign" },
    { "name": "account", "type": 1 },
    { "name": "date", "type": "<group_time>" }
  ],
  "..": "others params"
}

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

{
  "date": {
    "date_from": "2024-06-07T00:00:00.000Z",
    "date_to": "2024-06-07T23:59:59.000Z"
  },
  "platform": [10],
  "partner": [2],
  "campaign": [],
  "group_time": 1,
  "groupings": [
    {
      "name": "date",
      "type": 1
    },
    {
      "name": "partner"
    },
    {
      "name": "platform"
    },
    {
      "name": "sub_client"
    }
  ],
  "object": [],
  "sub_client": [],
  "type_cab": null,
  "currency": "RUB",
  "account_uids": []
}

Пример успешного ответа:

{
  "results": [
    {
      "account_name": "SOME_Test",
      "account_uid": "ACC0000000",
      "action_type": "join",
      "ad_id": 999999999,
      "ad_text": "example ad_text",
      "ad_type": "target_channels",
      "button_type": null,
      "campaign_plat": "example campaign plat",
      "clicks": 0,
      "cpc": 0.0,
      "cpm": 1.33,
      "ctr": 0.0,
      "cvr": 0.0,
      "date": "2024-06-09",
      "goals": 0.0,
      "impressions": 1.0,
      "object": "t.me/example",
      "opened": null,
      "price_target": 0.0,
      "promote_url": "t.me/example",
      "spent": 0.004,
      "target_bots": [],
      "target_channels": [],
      "target_countries": [],
      "target_langs": ["Russian"],
      "target_search": ["Russian"],
      "target_topics": ["Offers & Promotions"],
      "target_user_channels": [],
      "target_user_locations": [],
      "unit": 1016091001563,
      "website_name": null
    }
  ]
}

Описание параметров успешного ответа:

Поле	Тип	Описание
account_name	Строка	Название аккаунта.
account_uid	Строка	Уникальный идентификатор аккаунта.
action_type	Строка или null	Тип целевого действия.
ad_id	Число	Уникальный идентификатор объявления.
ad_text	Строка	Текст креатива.
ad_type	Строка	Тип объявления (например, target_channels, target_users, target_search, target_bots).
button_type	Строка или null	Текст кнопки.
campaign_plat	Строка	Наименование объявления.
clicks	Число	Клики.
cpc	Число	Стоимость за клик (CPC).
cpm	Число	Стоимость тысячи показов (CPM).
ctr	Число	Коэффициент кликабельности (CTR).
cvr	Число	Коэффициент конверсии (CVR).
date	Строка	Дата в формате "YYYY-MM-DD".
goals	Число	Цели.
impressions	Число	Количество показов объявления.
object	Строка	Объект рекламирования.
opened	Число или null	Открытий видео.
price_target	Число	Цена за цель.
promote_url	Строка	Конечный URL рекламируего объекта.
spent	Число	Расходы.
target_bots	Массив строк	Список ботов, на которые таргетируется объявление.
target_channels	Массив строк	Список каналов, на которые таргетируется объявление.
target_countries	Массив строк	Список стран, на которые таргетируется объявление.
target_langs	Массив строк	Список языков, на которые таргетируется объявление.
target_search	Массив строк	Список поисковых запросов, на которые таргетируется объявление.
target_topics	Массив строк	Список топиков, на которые таргетируется объявление.
target_user_channels	Массив строк	Список каналов, на которые таргетируется объявление.
target_user_locations	Массив строк	Список местоположений, на которые таргетируется объявление.
unit	Число	Внутренний параметр для технических нужд.
website_name	Строка	Название вебсайта.

Список объектов рекламирования

INFO

GET report/objects

Пример использования:

https://client.adstat.pro/api/report/objects

Параметры:

В заголовках HTTP запроса необходимо передать <access_token> в формате:

• Authorization: "Bearer <access_token>"

Пример успешного ответа:

["t.me/object", "https://example.ru"]