Récupérer les analyses par référent

api-referenceGET

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

Recuperez les donnees analytiques segmentees par source de referent.

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 facultatifs

Parametre	Taper	Description
`startAt`	`string`	Date/heure de début ISO 8601. 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 de votre 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).

Parametres de filtre

Parametre	Taper	Description
`filter_country`	`string`	Nom ou code du pays. Utiliser \| pour plusieurs valeurs et! pour exclure des valeurs.
`filter_region`	`string`	Region ou etat.
`filter_city`	`string`	Nom de ville.
`filter_device`	`string`	Type d'appareil. Utilisez des valeurs backend telles que Desktop\|Mobile\|Tablet et! à exclure.
`filter_browser`	`string`	Nom du navigateur. Safari inclut automatiquement Mobile Safari.
`filter_os`	`string`	Systeme d'exploitation.
`filter_referrer`	`string`	Domaine referent ou nom connu.
`filter_ref`	`string`	Parametre URL ref.
`filter_source`	`string`	Parametre URL source.
`filter_via`	`string`	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 de page.
`filter_entry_page`	`string`	Chemin de page d'entree.
`filter_hostname`	`string`	Nom d'hote/domaine.
`filter_channel`	`string`	Canal marketing.
`filter_goal`	`string`	Nom de l'objectif.

Exemple de requete (curl)

curl --request GET \
  --url https://analytics.flowsery.com/analytics/api/v1/referrers \
  --header 'Authorization: Bearer <api-key>'

200

{
  "status": "success",
  "data": [
    {
      "value": "x.com",
      "visitors": 3450,
      "revenue": 1240,
      "renewalRevenue": 120,
      "percentage": 29.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/x.com.ico"
    },
    {
      "value": "Direct/None",
      "visitors": 2890,
      "revenue": 4560,
      "renewalRevenue": 910,
      "percentage": 24.4,
      "iconUrl": null
    },
    {
      "value": "example.com",
      "visitors": 2150,
      "revenue": 2890,
      "renewalRevenue": 610,
      "percentage": 18.2,
      "iconUrl": "https://icons.duckduckgo.com/ip3/example.com.ico"
    },
    {
      "value": "google.com",
      "visitors": 1840,
      "revenue": 6780,
      "renewalRevenue": 1700,
      "percentage": 15.6,
      "iconUrl": "https://icons.duckduckgo.com/ip3/google.com.ico"
    },
    {
      "value": "newsletter.example.com",
      "visitors": 1230,
      "revenue": 2150,
      "renewalRevenue": 430,
      "percentage": 10.4,
      "iconUrl": "https://icons.duckduckgo.com/ip3/newsletter.example.com.ico"
    }
  ],
  "pagination": {
    "limit": 5,
    "offset": 0,
    "total": 119
  }
}