Docs
Пошук документації...⌘K

Діаграма параметрів UTM

API + MCP
GET/v3/web-analytics/utm-params-chart

Запити до цього ендпоїнта безкоштовні та не витрачають жодних одиниць API.

Параметри запиту

utm_params_to_chartstring

Вкажіть, які значення відображати на графіку (у вигляді списку, розділеного комами). Якщо не задано, за замовчуванням використовується (top5-by-visitors) (тобто будується графік для топ-5 значень за кількістю відвідувачів).

wherestring

Вираз фільтра. Може містити виміри та метрики.

Підтримуються такі виміри:

source_channel: Канал джерела
тип: string
перелік: "search" "llm" "email" "paid" "search/paid" "social" "unknown" "direct" "newsletter" "shopping/organic" "shopping/paid" "audio" "social/paid" "cross-network" "mobile-push-notification" "sms" "affiliate" "referral" "display" "internal"

source: Джерело
тип: string

source_referer: Джерело реферера
тип: string

source_referer_domain: Домен реферера
тип: string

utm_source: Джерело UTM
тип: string

utm_medium: Канал UTM
тип: string

utm_campaign: Кампанія UTM
тип: string

utm_term: Термін UTM
тип: string

utm_content: Вміст UTM
тип: string

page: URL сторінки
тип: url

page_domain: Домен сторінки
тип: string

page_title: Заголовок сторінки
тип: string

entry_page: URL вхідної сторінки
тип: url

exit_page: URL вихідної сторінки
тип: url

continent: Континент
тип: string
перелік: "AF" "AS" "EU" "NA" "OC" "SA" "AN" ""

country: Країна
тип: string

city: Місто
тип: string

browser_language: Мова браузера
тип: string

browser: Браузер
тип: string

browser_version: Версія браузера
тип: string

os: Операційна система
тип: string

os_version: Версія операційної системи
тип: string

device: Тип пристрою
тип: string

screensize: Розмір екрана
тип: string

event_name: Назва події
тип: string

is_external_link_click: Чи є кліком за зовнішнім посиланням
тип: boolean

event_prop:EVENT_PROP: користувацьку властивість події можна вказати за її назвою
тип: string

Підтримуються такі метрики:

pageviews: Кількість подій перегляду сторінки
тип: integer

visitors: Кількість відвідувачів
тип: integer

visits: Кількість візитів
тип: integer

session_bounce_rate: Показник відмов сесії (відсоток сесій, у яких було лише один запит)
тип: float

avg_session_length: Середня тривалість сесії (у секундах)
тип: float

avg_session_duration_sec: Середня тривалість сесії (у секундах)
тип: integer

exit_rate: Показник виходів (відсоток переглядів сторінок, які були останніми в сесії)
тип: float

exits: Кількість виходів
тип: integer

entries: Кількість входів
тип: integer

avg_page_visit_duration_sec: Середня тривалість відвідування сторінки (у секундах)
тип: integer

Фільтр — це рядок JSON, що представляє булевий вираз; він має відповідати такій структурі:

<bool_filter> ::= { "and" : <bool_filter>+ }
              |   { "or" : <bool_filter>+ }
              |   { "not" : <bool_filter> }
              |   <expr>

<expr> ::= {
             "field" : <dimension|metric>,
             ? "is": <condition>,
           }

<condition> ::= [ "eq", <value> ]
            |   [ "neq", <value> ]
            |   [ "gt", <value> ]
            |   [ "gte", <value> ]
            |   [ "lt", <value> ]
            |   [ "lte", <value> ]
            |   [ "substring", <value> ]
            |   [ "isubstring", <value> ]
            |   [ "phrase_match", <value> ]
            |   [ "iphrase_match", <value> ]
            |   [ "prefix", <value> ]
            |   [ "suffix", <value> ]
granularitystringОбов’язково

Часова деталізація точок даних на графіку: hourly, daily, weekly або monthly.

tostring

кінцева дата й час для запиту даних

fromstring

початкова дата й час для запиту даних

utm_paramstringОбов’язково

Вкажіть параметр UTM, який слід використовувати як вимір (один із utm_source, utm_medium, utm_campaign, utm_term або utm_content).

Дозволені значення:utm_sourceutm_mediumutm_campaignutm_termutm_content
project_idintegerОбов’язково

ID проєкту

outputstring

Формат виводу.

Дозволені значення:jsoncsvxmlphp

Відповіді

pointsarray<object>
timestampstring

Мітка часу точки даних

utm_paramstring

Значення параметра UTM

visitorsinteger

Кількість відвідувачів

session_bounce_ratenumber

Показник відмов у сеансах (відсоток сеансів, що спричинили лише один запит)

avg_session_duration_secinteger

Середня тривалість сеансу (у секундах)