search

API-методы

Список всех доступных методов

hashtag
Получение списка кабинетов

POST https://api.tgbooster.ru/api/cabinets

Получение рекламных кабинетов пользователя

{
    "success": true,
    "cabinets": [
        {
            "id": 1,
            "name": "Cabinet / 1",
            "photo": "photo",
            "created_at": "2023-08-15T12:47:46.000000Z"
        },
        {
            "id": 2,
            "name": "Cabinet / 2",
            "photo": "photo",
            "created_at": "2023-08-03T13:37:11.000000Z"
        },
        {
            "id": 3,
            "name": "Cabinet / 3",
            "photo": "photo",    
            "created_at": "2023-04-17T11:52:35.000000Z"
        },
        {
            "id": 4,
            "name": "Cabinet / 4",
            "photo": "photo",
            "created_at": "2023-03-11T20:13:38.000000Z"
        }
    ]
}

hashtag
Получение списка кампаний с возможностью фильтрации статистики

POST https://api.tgbooster.ru/api/cabinet/{CabinetId}/companies

Получение списка рекламных кампаний выбранного кабинета. По умолчанию, кампания с system: 1 это кампания, в которую попадают нераспределенные по кампаниям объявления из telegram ads.

CabinetId - это ID кабинета, полученного из метода /cabinets

hashtag
Request Body

Name
Type
Description

filters[start_date]

Date

Фильтрация статистики рекламных кампаний

filters[finish_date]

Date

Фильтрация статистики рекламных кампаний

hashtag
Получение отчетов

POST https://api.tgbooster.ru/api/cabinet/{CabinetId}/reports

Своего рода мастер отчетов. В зависимости от указанных группировок, фильтраций и метрик, система выдаст подробный отчет.

Примеры

Можно сгруппировать отчет так, чтобы посмотреть, какой рекламный текст имеет наивысший CTR или CPS за всю историю.

Или можно комбинировать сразу несколько группировок. Например: Date Day и Ads Ad_url. Тогда на каждый день и на каждый Ad url будет своя статистика.

hashtag
Request Body

Name
Type
Description

groups[date][day]

Boolean

Группировка по дням

groups[date][week]

Boolean

Группировка по неделям

groups[ads][company]

Boolean

Группировка по кампаниям

groups[ads][ad]

Boolean

Группировка по объявлениям

groups[ads][ad_url]

Boolean

Группировка по URL объявления

filters[company]

Array

ID рекламных кампаний в массиве. Пример: [1, 2]

filters[dates]

Array

Фильтрация отчета по датам. Пример: "dates": ["2023-03-01", "2023-09-10"]. Означает фильтрация с 1 марта по 10 сентября 2023 года.

metrics[views]

Boolean

Отобразить метрику показов

metrics[clicks]

Boolean

Отобразить метрику кликов

metrics[joins]

Boolean

Отобразить метрику вступлений

metrics[spent]

Boolean

Отобразить метрику расходов

metrics[ctr]

Boolean

Отобразить метрику CTR

metrics[cv]

Boolean

Отобразить конверсию из показов в вступления

metrics[cpc]

Boolean

Отобразить метрику CPC

metrics[cps]

Boolean

Отобразить метрику CPS

PreviousАутентификация

Last updated