TD API 2.0 - Getting hourly statistics

📘

Адрес для отправки запросов:

https://tdm4.adcloud.org/api/v2/?method=MethodName

В качестве get-параметра необходимо передавать название метода, что позволит динамически определить метод через URL-строку.

Получение почасовой статистики по рекламным кампаниям клиента

"method": "Statistic.getSourceDate" позволяет пользователю получить почасовую статистику в разбивке: Рекламная кампания → Источник → Время суток (часы).

Для этого необходимо выполнить запрос, указав в качестве параметров "partner_xxhash" - xxhash клиента, а также период времени, за который необходимы статистические данные.

Параметры запроса:

  • partner_xxhash - ID клиента (тип string),
  • period - объект с двумя датами, начало и конец периода, строки формата YYYY-MM-DD.

Параметры ответа:

  • "client_id" - Уникальный ID клиента,
  • "client_title" - Название клиента,
  • "campaigns" - Массив кампаний клиента,
  • "campaign_id" - Уникальный ID кампании,
  • "campaign_title" - Название кампании,
  • "source" - Массив источников,
  • "ssp_test_1" - Название источника,
  • "2023-11-17 13:00:00" - Массив статистических данных по часам, по МСК. Какие данные входят в статистику подробнее смотрите ниже.

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

{
  "jsonrpc": "2.0",
  "method": "Statistic.getSourceDate",
  "params": {
    "partner_xxhash":"F509DE02732B74ED",
    "period": {
      "from": "2023-10-29",
      "to": "2023-10-29"
    }
  },
  "id": 1
}

Пример ответа:

{
  "jsonrpc": "2.0",
  "result": {
    "client_id": "tdm4#1234",
    "client_title": "Name client",
    "campaigns": [
      {
        "campaign_id": "tdm4#1234.1",
        "campaign_title": "Name campaign",
        "source": {
          "ssp_test": {
            "2023-11-17 13:00:00": {
              "cpm_bid": 99.99999999999947,
              "minus_win_raw_tt": 126.89999999999934,
              "margin": 0,
              "bid_statistic": "11298",
              "show": "1269",
              "accept": "0",
              "convs_val": 0,
              "click": "5",
              "fclick": "1",
              "cpc": 25.379999999999868,
              "cpm": 99.99999999999947,
              "ctr": 0.39401103230890466,
              "spent": 126.89999999999934,
              "cpo": 0,
              "minus_bid": 126.89999999999934
            },
            "2023-11-17 00:00:00": {...},
            "2023-11-17 01:00:00": {...},
            "2023-11-17 02:00:00": {...},
            "2023-11-17 03:00:00": {...}
          },
          "yandex_rtb": {
            "2023-11-17 00:00:00": {...},
            "2023-11-17 01:00:00": {...},
            "2023-11-17 02:00:00": {...},
            "2023-11-17 03:00:00": {...}
          },
          "sape": {
            "2023-11-17 00:00:00": {...},
            "2023-11-17 01:00:00": {...},
            "2023-11-17 02:00:00": {...},
            "2023-11-17 03:00:00": {...}
          }
        }
      },
      {
        "campaign_id": "tdm4#1233.1",
        "campaign_title": "Name campaign 2",
        "source": {...}
      }
    ]
  },
  "id": 1
}

Метод возвращает в секции результатов почасовую статистику за указанный в запросе период времени и по всем кампаниям клиента. То есть отдельно для каждой рекламной кампании, для каждого источника внутри кампании будет выведена статистика по часам.

В статистику входят следующие данные:

ПолеОписаниеФормулаПример значения
showКоличество показов-1269
clickКоличество кликов-5
cpcРассчитанный cpc (стоимость одного клика)-25.38
cpmРассчитанный cpm (стоимость 1000 показов)-100
ctrCTR в % (кликабельность)click * 100 / show0.394
spentРасход в текущей валюте-126.9
acceptConvs. - конверсии-0
convs_valСумма дохода с заказа в текущей валюте100 * (spent / convs_val)0
cpoстоимость одной конверсииspent / accept0
win_percWinRate,% - процент доступного трафика на основе ставки100 * show / bid
marginЧистая маржинальность в текущей валютеspent - spent_f0
margin_revОтношение маржи к выручке100 * (margin / spent)
spent_fФактический Расход-
cpc_fФактический CPC-
crCR% - коэффициент конверсииact1 / click * 100
cpm_bidСтавка, посчитанная из расхода и поставленного BID в таргете “Источники“-
cpm_fФактический CPM, стоимость 1000 показов-
drrДРР - доля рекламных расходов100 * (spent / convs_val)