Récupérer l'aperçu du site

api-referenceGET

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

Recuperez les metriques analytiques agregees pour votre site web.

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
`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`	Identifiant de fuseau horaire IANA. Se rabat sur le fuseau horaire configure du site.

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 (Chrome, Safari, Firefox, Edge). 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.

Notes

Sans plage de dates, l'API utilise les 30 derniers jours jusqu'à maintenant. bounceRate et conversionRate sont des pourcentages ; avgSessionDuration et avgEngagedTime sont en secondes. Les valeurs de filtre acceptent | pour plusieurs valeurs, ! pour exclure et ~ pour une correspondance partielle.

Exemple de requete (curl)

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

200

{
  "status": "success",
  "data": [
    {
      "visitors": 12450,
      "sessions": 16890,
      "bounceRate": 65.32,
      "avgSessionDuration": 246,
      "avgEngagedTime": 187,
      "revenue": 28450,
      "renewalRevenue": 6320,
      "refundedRevenue": 410,
      "revenuePerVisitor": 2.29,
      "conversionRate": 1.15,
      "kpiValue": 28450,
      "kpiPerVisitor": 2.29,
      "kpiConversionRate": 1.15,
      "currency": "USD"
    }
  ]
}