Récupérer les analyses par canal

api-referenceGET

GEThttps://analytics.flowsery.com/analytics/api/v1/channels

Récupérer les données analytiques segmentées par canal d'acquisition.

Jeton Bearer (jeton workspace ou clé API de site)

Les jetons d'espace de travail nécessitent un sélecteur de site Web

Les jetons de l'API Workspace peuvent accéder à tous les sites Web de l'espace de travail. Transmettez websiteId ou domain pour que Flowsery sache quel site Web interroger ou muter. Les clés API de site Web sont déjà limitées à un seul site Web, le sélecteur peut donc être omis.

Sélecteur de site Web

Paramètre	Taper	Description
`websiteId`	`string`	ID de site Web à utiliser avec un jeton API d'espace de travail. Omettre lors de l'authentification avec une clé API de site Web.
`domain`	`string`	Site Web domain à utiliser avec un jeton API d'espace de travail lorsque websiteId n'est pas fourni. Omettre lors de l'authentification avec une clé API de site Web.

Paramètres de requête

Paramètre	Taper	Description
`startAt`	`string`	Date/heure de début ISO 8601 (par exemple 2024-01-01T00:00:00Z). La valeur par défaut est les 30 derniers jours en cas d'omission.
`endAt`	`string`	Date/heure de fin ISO 8601. La valeur par défaut est maintenant lorsqu'elle est omise.
`timezone`	`string`	Fuseau horaire pour l'agrégation (par ex., UTC, America/New_York). Se rabat sur le fuseau horaire configuré du site.
`limit`	`number`	Nombre maximum de lignes à retourner (1-1000, par défaut : 100).
`offset`	`number`	Lignes à ignorer pour la pagination (min 0, par défaut : 0).

Paramètres de filtre

Paramètre	Taper	Description
`filter_country`	`string`	Nom du pays tel que renvoyé par /countries, par ex. United States. Utilisez \| pour plusieurs valeurs, ! pour exclure et ~ pour une correspondance partielle.
`filter_region`	`string`	Nom de la région ou de l'État tel que renvoyé par /regions, par ex. California.
`filter_city`	`string`	Nom de ville.
`filter_device`	`string`	Type d'appareil : Desktop, Mobile ou Tablet. Les valeurs respectent la casse.
`filter_browser`	`string`	Nom du navigateur. Safari inclut automatiquement Mobile Safari.
`filter_os`	`string`	Système d'exploitation (Mac OS, Windows, iOS, Android).
`filter_referrer`	`string`	Référent tel que renvoyé par /referrers : un nom de source comme Google pour les sites reconnus, sinon le domaine.
`filter_ref`	`string`	Valeur du paramètre URL ref.
`filter_source`	`string`	Valeur du paramètre URL source.
`filter_via`	`string`	Valeur du paramètre URL via.
`filter_utm_source`	`string`	Source UTM.
`filter_utm_medium`	`string`	Medium UTM.
`filter_utm_campaign`	`string`	Campagne UTM.
`filter_utm_term`	`string`	Terme UTM.
`filter_utm_content`	`string`	Contenu UTM.
`filter_page`	`string`	Chemin ou URL de page.
`filter_entry_page`	`string`	Chemin ou URL de page d'entrée.
`filter_hostname`	`string`	Nom d'hôte/domaine.
`filter_channel`	`string`	Canal marketing.
`filter_goal`	`string`	Nom de l'objectif.

Champs de réponse

Chaque élément du tableau data contient le nom du canal dans value, le nombre de visiteurs, le revenu réparti entre newRevenue et renewalRevenue, et sa part des visiteurs dans percentage. Les noms de canaux sont renvoyés en anglais : Direct, Organic search, Paid search, Organic social, Paid social, Referral, Email, A.I., Display, Video, Affiliate, SMS et Audio.

Combiner les filtres

Séparez plusieurs valeurs d'un même paramètre de filtre par |. Passez un nom de canal à filter_channel sur n'importe quel autre rapport pour le limiter à ce canal (ex. filter_channel=Organic search|Paid search).

Exemple de requête (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/channels?limit=5' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "Organic search",
      "visitors": 4120,
      "revenue": 8340,
      "newRevenue": 6910,
      "renewalRevenue": 1430,
      "percentage": 38.6
    },
    {
      "value": "Direct",
      "visitors": 2870,
      "revenue": 5120,
      "newRevenue": 4080,
      "renewalRevenue": 1040,
      "percentage": 26.9
    },
    {
      "value": "Organic social",
      "visitors": 1640,
      "revenue": 1980,
      "newRevenue": 1760,
      "renewalRevenue": 220,
      "percentage": 15.4
    },
    {
      "value": "Referral",
      "visitors": 1210,
      "revenue": 2450,
      "newRevenue": 2010,
      "renewalRevenue": 440,
      "percentage": 11.3
    },
    {
      "value": "Email",
      "visitors": 830,
      "revenue": 1760,
      "newRevenue": 1290,
      "renewalRevenue": 470,
      "percentage": 7.8
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 9
  }
}