Docs
Rechercher dans la documentation...⌘K

Paramètres UTM

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

Les requêtes vers ce point de terminaison sont gratuites et ne consomment aucune unité d’API.

Paramètres de requête

limitinteger

Nombre de résultats à renvoyer.

order_bystring

Trier par métrique, au format metric:desc ou metric:asc. Les métriques suivantes sont prises en charge :

pageviews : Nombre d’événements de pages vues
type: integer

visitors : Nombre de visiteurs
type: integer

visits : Nombre de visites
type: integer

session_bounce_rate : Taux de rebond des sessions (pourcentage de sessions n’ayant déclenché qu’une seule requête)
type: float

avg_session_length : Durée moyenne de session (en secondes)
type: float

avg_session_duration_sec : Durée moyenne de session (en secondes)
type: integer

exit_rate : Taux de sortie (pourcentage de pages vues qui étaient les dernières de la session)
type: float

exits : Nombre de sorties
type: integer

entries : Nombre d’entrées
type: integer

avg_page_visit_duration_sec : Durée moyenne de visite d’une page (en secondes)
type: integer

wherestring

Expression de filtre. Peut mentionner des dimensions et des métriques.

Les dimensions suivantes sont prises en charge :

source_channel : Canal source
type : string
enum : "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 : Source
type : string

source_referer : Source du référent
type : string

source_referer_domain : Domaine du référent
type : string

utm_source : Source UTM
type : string

utm_medium : Médium UTM
type : string

utm_campaign : Campagne UTM
type : string

utm_term : Terme UTM
type : string

utm_content : Contenu UTM
type : string

page : URL de la page
type : url

page_domain : Domaine de la page
type : string

page_title : Titre de la page
type : string

entry_page : URL de la page d'entrée
type : url

exit_page : URL de la page de sortie
type : url

continent : Continent
type : string
enum : "AF" "AS" "EU" "NA" "OC" "SA" "AN" ""

country : Pays
type : string

city : Ville
type : string

browser_language : Langue du navigateur
type : string

browser : Navigateur
type : string

browser_version : Version du navigateur
type : string

os : Système d'exploitation
type : string

os_version : Version du système d'exploitation
type : string

device : Type d'appareil
type : string

screensize : Taille d'écran
type : string

event_name : Nom de l'événement
type : string

is_external_link_click : Est un clic sur un lien externe
type : boolean

event_prop:EVENT_PROP : une propriété d'événement personnalisée peut être spécifiée par son nom
type : string

Les métriques suivantes sont prises en charge :

pageviews : Nombre d'événements de pages vues
type : integer

visitors : Nombre de visiteurs
type : integer

visits : Nombre de visites
type : integer

session_bounce_rate : Taux de rebond de session (pourcentage de sessions n'ayant déclenché qu'une seule requête)
type : float

avg_session_length : Durée moyenne de session (en secondes)
type : float

avg_session_duration_sec : Durée moyenne de session (en secondes)
type : integer

exit_rate : Taux de sortie (pourcentage de pages vues qui étaient les dernières de la session)
type : float

exits : Nombre de sorties
type : integer

entries : Nombre d'entrées
type : integer

avg_page_visit_duration_sec : Durée moyenne de visite de page (en secondes)
type : integer

Le filtre est une chaîne JSON représentant une expression booléenne ; il doit respecter la structure suivante :

<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> ]
tostring

Date et heure de fin pour la requête de données

fromstring

Date et heure de début pour la requête de données

utm_paramstringObligatoire

Spécifiez un paramètre UTM à utiliser comme dimension (l’un de utm_source, utm_medium, utm_campaign, utm_term ou utm_content).

Valeurs autorisées:utm_sourceutm_mediumutm_campaignutm_termutm_content
project_idintegerObligatoire

ID du projet

outputstring

Le format de sortie.

Valeurs autorisées:jsoncsvxmlphp

Réponses

statsarray<object>
utm_paramstring

Valeur du paramètre UTM

visitorsinteger

Nombre de visiteurs

session_bounce_ratenumber

Taux de rebond de session (pourcentage des sessions n’ayant déclenché qu’une seule requête)

avg_session_duration_secinteger

Durée moyenne de session (en secondes)