api-referenceGET
GET
https://analytics.flowsery.com/analytics/api/v1/metadataRecuperez les metadonnees de configuration de 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. |
Champs de reponse
Champs de reponse
| Parametre | Taper | Description |
|---|---|---|
domain | string | Le domaine du site web. |
timezone | string | Identifiant de fuseau horaire IANA pour le site (par ex., "America/New_York", "UTC"). |
name | string | Nom d'affichage personnalise pour le site web. |
logo | string | null | URL du logo personnalise du site, ou null lorsqu'aucun n'est defini. |
kpiColorScheme | string | Schema de couleurs utilise pour les visualisations KPI. Valeurs possibles : red, orange, yellow, green, purple, pink, gray, blue, teal, indigo. |
kpi | string | null | Le nom de l'objectif/evenement personnalise designe comme indicateur cle de performance pour ce site. |
currency | string | Code de devise (par ex., "USD", "EUR", "GBP"). |
Exemple de requete (curl)
curl --request GET \
--url https://analytics.flowsery.com/analytics/api/v1/metadata \
--header 'Authorization: Bearer <api-key>'200
{
"status": "success",
"data": [
{
"domain": "example.com",
"timezone": "America/New_York",
"name": "My Awesome Website",
"logo": "https://d1aebdcemlt4l7.cloudfront.net/website-logos/xK9mPq2bR7nYwJ3vL5tA.png",
"kpiColorScheme": "orange",
"kpi": "signup",
"currency": "USD"
}
]
}