API-методы
Список всех доступных методов
Получение списка кабинетов
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"
}
]
}Получение списка кампаний с возможностью фильтрации статистики
POST https://api.tgbooster.ru/api/cabinet/{CabinetId}/companies
Получение списка рекламных кампаний выбранного кабинета. По умолчанию, кампания с system: 1 это кампания, в которую попадают нераспределенные по кампаниям объявления из telegram ads.
CabinetId - это ID кабинета, полученного из метода /cabinets
Request Body
filters[start_date]
Date
Фильтрация статистики рекламных кампаний
filters[finish_date]
Date
Фильтрация статистики рекламных кампаний
{
"success": true,
"campaigns": [
{
"id": 912,
"cabinet_id": 242,
"name": "Default",
"status_id": 1,
"system": 1,
"created_at": "2023-08-15T12:47:46.000000Z",
"updated_at": "2023-08-15T12:47:46.000000Z",
"ads_count": 36,
"ads_active_count": 4,
"ads_sum_budget": "114.77",
"stat_views": "3371",
"stat_clicks": "54",
"stat_joins": "11",
"stat_spent": "112.11",
"status": {
"id": 1,
"name": "Запущен",
"indicator": "bg-success",
"created_at": null,
"updated_at": null
}
}
]
}Получение отчетов
POST https://api.tgbooster.ru/api/cabinet/{CabinetId}/reports
Своего рода мастер отчетов. В зависимости от указанных группировок, фильтраций и метрик, система выдаст подробный отчет.
Примеры
Можно сгруппировать отчет так, чтобы посмотреть, какой рекламный текст имеет наивысший CTR или CPS за всю историю.
Или можно комбинировать сразу несколько группировок. Например: Date Day и Ads Ad_url. Тогда на каждый день и на каждый Ad url будет своя статистика.
Request Body
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
{
"success": true,
"data": [
{
"date_day": "2023-08-15",
"metric_views": "871",
"metric_clicks": "7",
"metric_joins": "1",
"metric_spent": "19.93",
"metric_ctr": 0.8036739380022963,
"metric_cv": 0.1148105625717566,
"metric_cpc": 2.847142857142857,
"metric_cps": 19.93
},
{
"date_day": "2023-08-16",
"metric_views": "660",
"metric_clicks": "8",
"metric_joins": "1",
"metric_spent": "22.53",
"metric_ctr": 1.2121212121212122,
"metric_cv": 0.15151515151515152,
"metric_cpc": 2.81625,
"metric_cps": 22.53
},
{
"date_day": "2023-08-17",
"metric_views": "184",
"metric_clicks": "1",
"metric_joins": "0",
"metric_spent": "2.78",
"metric_ctr": 0.5434782608695652,
"metric_cv": 0,
"metric_cpc": 2.78,
"metric_cps": 0
},
{
"date_day": "2023-08-18",
"metric_views": "5",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.18",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-08-19",
"metric_views": "494",
"metric_clicks": "0",
"metric_joins": "3",
"metric_spent": "13.15",
"metric_ctr": 0,
"metric_cv": 0.6072874493927125,
"metric_cpc": 0,
"metric_cps": 4.383333333333334
},
{
"date_day": "2023-08-20",
"metric_views": "1538",
"metric_clicks": "2",
"metric_joins": "8",
"metric_spent": "33.81",
"metric_ctr": 0.13003901170351106,
"metric_cv": 0.5201560468140443,
"metric_cpc": 16.905,
"metric_cps": 4.22625
},
{
"date_day": "2023-08-21",
"metric_views": "976",
"metric_clicks": "0",
"metric_joins": "5",
"metric_spent": "21.24",
"metric_ctr": 0,
"metric_cv": 0.5122950819672131,
"metric_cpc": 0,
"metric_cps": 4.247999999999999
},
{
"date_day": "2023-08-22",
"metric_views": "4501",
"metric_clicks": "20",
"metric_joins": "11",
"metric_spent": "72.57",
"metric_ctr": 0.4443457009553432,
"metric_cv": 0.2443901355254388,
"metric_cpc": 3.6285,
"metric_cps": 6.597272727272727
},
{
"date_day": "2023-08-23",
"metric_views": "1881",
"metric_clicks": "35",
"metric_joins": "17",
"metric_spent": "35.00",
"metric_ctr": 1.8607123870281765,
"metric_cv": 0.9037745879851143,
"metric_cpc": 1,
"metric_cps": 2.0588235294117645
},
{
"date_day": "2023-08-24",
"metric_views": "1671",
"metric_clicks": "33",
"metric_joins": "15",
"metric_spent": "36.28",
"metric_ctr": 1.9748653500897666,
"metric_cv": 0.8976660682226212,
"metric_cpc": 1.0993939393939394,
"metric_cps": 2.4186666666666667
},
{
"date_day": "2023-08-25",
"metric_views": "1289",
"metric_clicks": "26",
"metric_joins": "9",
"metric_spent": "26.44",
"metric_ctr": 2.017067494181536,
"metric_cv": 0.6982156710628394,
"metric_cpc": 1.016923076923077,
"metric_cps": 2.937777777777778
},
{
"date_day": "2023-08-26",
"metric_views": "228",
"metric_clicks": "9",
"metric_joins": "5",
"metric_spent": "5.61",
"metric_ctr": 3.9473684210526314,
"metric_cv": 2.1929824561403506,
"metric_cpc": 0.6233333333333334,
"metric_cps": 1.122
},
{
"date_day": "2023-08-27",
"metric_views": "1710",
"metric_clicks": "11",
"metric_joins": "3",
"metric_spent": "33.64",
"metric_ctr": 0.6432748538011697,
"metric_cv": 0.17543859649122806,
"metric_cpc": 3.058181818181818,
"metric_cps": 11.213333333333333
},
{
"date_day": "2023-08-28",
"metric_views": "9",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.32",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-08-29",
"metric_views": "6",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.21",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-08-30",
"metric_views": "6",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.21",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-08-31",
"metric_views": "43",
"metric_clicks": "2",
"metric_joins": "1",
"metric_spent": "1.90",
"metric_ctr": 4.651162790697675,
"metric_cv": 2.3255813953488373,
"metric_cpc": 0.95,
"metric_cps": 1.9
},
{
"date_day": "2023-09-01",
"metric_views": "82",
"metric_clicks": "2",
"metric_joins": "0",
"metric_spent": "4.40",
"metric_ctr": 2.4390243902439024,
"metric_cv": 0,
"metric_cpc": 2.2,
"metric_cps": 0
},
{
"date_day": "2023-09-02",
"metric_views": "4",
"metric_clicks": "1",
"metric_joins": "1",
"metric_spent": "0.22",
"metric_ctr": 25,
"metric_cv": 25,
"metric_cpc": 0.22,
"metric_cps": 0.22
},
{
"date_day": "2023-09-03",
"metric_views": "25",
"metric_clicks": "1",
"metric_joins": "0",
"metric_spent": "1.38",
"metric_ctr": 4,
"metric_cv": 0,
"metric_cpc": 1.38,
"metric_cps": 0
},
{
"date_day": "2023-09-04",
"metric_views": "11",
"metric_clicks": "1",
"metric_joins": "0",
"metric_spent": "0.70",
"metric_ctr": 9.090909090909092,
"metric_cv": 0,
"metric_cpc": 0.7,
"metric_cps": 0
},
{
"date_day": "2023-09-05",
"metric_views": "182",
"metric_clicks": "9",
"metric_joins": "1",
"metric_spent": "10.84",
"metric_ctr": 4.945054945054945,
"metric_cv": 0.5494505494505495,
"metric_cpc": 1.2044444444444444,
"metric_cps": 10.84
},
{
"date_day": "2023-09-06",
"metric_views": "499",
"metric_clicks": "16",
"metric_joins": "2",
"metric_spent": "28.07",
"metric_ctr": 3.2064128256513023,
"metric_cv": 0.4008016032064128,
"metric_cpc": 1.754375,
"metric_cps": 14.035
},
{
"date_day": "2023-09-07",
"metric_views": "1",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.06",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-09-08",
"metric_views": "2",
"metric_clicks": "0",
"metric_joins": "0",
"metric_spent": "0.11",
"metric_ctr": 0,
"metric_cv": 0,
"metric_cpc": 0,
"metric_cps": 0
},
{
"date_day": "2023-09-09",
"metric_views": "201",
"metric_clicks": "6",
"metric_joins": "0",
"metric_spent": "8.03",
"metric_ctr": 2.9850746268656714,
"metric_cv": 0,
"metric_cpc": 1.3383333333333332,
"metric_cps": 0
},
{
"date_day": "2023-09-10",
"metric_views": "234",
"metric_clicks": "4",
"metric_joins": "0",
"metric_spent": "8.86",
"metric_ctr": 1.7094017094017095,
"metric_cv": 0,
"metric_cpc": 2.215,
"metric_cps": 0
}
]
}Last updated