Récupérer une ventilation par n'importe quelle dimension

api-referenceGET

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

Regrouper les visiteurs selon l'une des 25 dimensions, y compris celles sans endpoint dédié comme entry_page, exit_link, browser_version, os_version, via et chaque paramètre UTM.

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 <code>websiteId</code> ou <code>domain</code> 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

Parametre	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.

Parametres de requete

Parametre	Taper	Description
`dimension`REQUIS	`string`	L'attribut de regroupement des visiteurs : l'une des 25 valeurs listées sous Dimensions. Toute autre valeur renvoie 400.
`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'agregation (par ex., UTC, America/New_York). Se rabat sur le fuseau horaire configure du site.
`limit`	`number`	Nombre maximum de lignes a retourner (1-1000, par defaut : 100).
`offset`	`number`	Lignes a ignorer pour la pagination (min 0, par defaut : 0).

Dimensions

Parametre	Taper	Description
`device`	`string`	Type d'appareil : Desktop, Mobile ou Tablet.
`page`	`string`	Chemin de la page.
`entry_page`	`string`	Première page de la session.
`exit_link`	`string`	Lien sortant sur lequel le visiteur a cliqué pour quitter le site. Le revenu vaut toujours 0.
`hostname`	`string`	Nom d'hôte qui a servi la page.
`referrer`	`string`	Nom de la source référente, comme Google, ou le domaine pour les sites que Flowsery ne reconnaît pas. Les lignes incluent iconUrl.
`channel`	`string`	Canal d'acquisition, les mêmes lignes que GET /channels.
`campaign`	`string`	Campagne UTM, les mêmes lignes que GET /campaigns.
`goal`	`string`	Nom de l'objectif. visitors contient le nombre de complétions et le revenu vaut toujours 0.
`country`	`string`	Nom du pays. Les lignes incluent countryCode.
`region`	`string`	Région ou État sous son nom complet, comme California. Les lignes incluent countryCode.
`city`	`string`	Nom de la ville. Les lignes incluent countryCode.
`browser`	`string`	Nom du navigateur.
`browser_version`	`string`	Version du navigateur.
`os`	`string`	Système d'exploitation.
`os_version`	`string`	Version du système d'exploitation.
`utm_source`	`string`	Le paramètre URL utm_source.
`utm_medium`	`string`	Le paramètre URL utm_medium.
`utm_campaign`	`string`	Le paramètre URL utm_campaign.
`utm_term`	`string`	Le paramètre URL utm_term.
`utm_content`	`string`	Le paramètre URL utm_content.
`ref`	`string`	Le paramètre URL ref.
`source`	`string`	Le paramètre URL source.
`via`	`string`	Le paramètre URL via, souvent utilisé pour les liens d'affiliation et de partenaires.
`all_params`	`string`	Tous les paramètres de suivi de la session réunis en une seule valeur, comme utm_source=google&utm_medium=cpc.

Parametres de filtre

Parametre	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`	Systeme 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 parametre URL ref.
`filter_source`	`string`	Valeur du parametre URL source.
`filter_via`	`string`	Valeur du parametre 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'entree.
`filter_hostname`	`string`	Nom d'hote/domaine.
`filter_channel`	`string`	Canal marketing.
`filter_goal`	`string`	Nom de l'objectif.

Champs de reponse

Chaque élément du tableau <code>data</code> contient la valeur regroupée dans <code>value</code>, le nombre de visiteurs, le revenu réparti entre <code>newRevenue</code> et <code>renewalRevenue</code>, et sa part des visiteurs dans <code>percentage</code>. Les dimensions géographiques ajoutent <code>countryCode</code> et <code>referrer</code> ajoute <code>iconUrl</code>. Une valeur non capturée est renvoyée comme <code>Unknown</code>.

Les valeurs correspondent aux filtres

Les valeurs sont renvoyées sous la forme attendue par les paramètres <code>filter_*</code>, vous pouvez donc renvoyer n'importe quelle ligne comme filtre. Les régions sont des noms complets (<code>California</code>, pas <code>CA</code>), les appareils commencent par une majuscule (<code>Desktop</code>, <code>Mobile</code>, <code>Tablet</code>) et les référents sont des noms de source (<code>Google</code>, pas <code>google.com</code>).

Combiner les filtres

Séparez plusieurs valeurs d'un même paramètre de filtre par |. Combinez une dimension avec des filtres pour répondre à des questions plus précises (ex. <code>dimension=via&filter_country=United States&filter_device=Mobile</code>).

Exemple de requête (Curl)

curl --request GET \
  --url 'https://analytics.flowsery.com/analytics/api/v1/breakdown?dimension=via&limit=3' \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "partner_anna",
      "visitors": 640,
      "revenue": 2310,
      "newRevenue": 1980,
      "renewalRevenue": 330,
      "percentage": 51.2
    },
    {
      "value": "partner_marc",
      "visitors": 410,
      "revenue": 1270,
      "newRevenue": 1270,
      "renewalRevenue": 0,
      "percentage": 32.8
    },
    {
      "value": "podcast",
      "visitors": 200,
      "revenue": 380,
      "newRevenue": 290,
      "renewalRevenue": 90,
      "percentage": 16
    }
  ],
  "pagination": {
    "limit": 3,
    "offset": 0,
    "total": 14
  }
}