Skip to main content
GET
Obtenir les analytics de trafic d'un site web
string
requis
La clé d’API de votre compte. Vous pouvez la trouver dans les paramètres de votre compte.
Nécessite une clé API avec le scope apps:read. Analytics agrège le trafic edge Cloudflare pour le domaine squareweb.app par défaut de l’application ainsi que tout domaine personnalisé rattaché : nombre de requêtes, bande passante, nombre de visiteurs, et répartitions par pays, appareil, OS, navigateur, protocole, méthode, chemin, referer et réseau client. Utilisez-le pour construire des tableaux de bord de trafic ou repérer des schémas inhabituels sans avoir à extraire les logs de requêtes bruts. Les résultats sont mis en cache par tranches de 5 minutes, si bien qu’interroger plusieurs fois la même fenêtre reste peu coûteux. Les cache miss partagent une limite unique de 20 requêtes par 60 secondes par propriétaire de l’application, entre les endpoints analytics, erreurs, logs et performance. Les réponses en cache ne sont pas comptabilisées. Lors des périodes de forte charge sur l’ensemble de la plateforme, l’endpoint peut renvoyer à la place les données en cache les plus récentes pour la fenêtre demandée. La fenêtre de rétention maximale est de 7 jours, et le début effectif est borné à la date de création de l’application. Contrairement aux Logs réseau et à la Performance réseau, cet endpoint est disponible sur tous les plans, pas seulement Pro et Enterprise. Pour un trafic centré sur les erreurs plutôt que sur le trafic global, voir Erreurs réseau. Pour purger les réponses edge mises en cache après un déploiement, voir Purger le cache.

Paramètres

string
requis
L’ID de l’application. Vous le trouverez dans l’URL du dashboard de votre application.
string
requis
Timestamp de début ISO 8601 pour la fenêtre d’analyse. La fenêtre de rétention maximale est de 7 jours ; le début est borné à la date de création de l’application.
string
requis
Timestamp de fin ISO 8601. Doit être postérieur à start.

Filtres d’exploration

Filtres optionnels qui restreignent chaque répartition au trafic correspondant. Réutilisez la valeur exacte de type renvoyée par la répartition correspondante dans une réponse précédente. Les filtres se combinent (ET).
string
Un unique pays client (code à 2 caractères), tel que renvoyé dans la répartition countries.
string
Une unique IP cliente (correspondance exacte IPv4/IPv6), telle que renvoyée dans la répartition ips.
string
Chemins de requête commençant par ce préfixe (par ex. /api couvre /api/*). Maximum 256 caractères.
string
Un unique code de statut de réponse edge (3 chiffres), tel que renvoyé dans la répartition status_codes.
string
Un unique OS client, tel que renvoyé dans la répartition os.
string
Un unique navigateur client, tel que renvoyé dans la répartition browsers.
string
Un unique protocole HTTP, tel que renvoyé dans la répartition protocols.
string
Un unique host referer, tel que renvoyé dans la répartition referers (Direct = aucun referer).
string
Un unique réseau client, avec la valeur type exacte renvoyée par la répartition providers, par ex. GOOGLE (15169). Un numéro d’ASN brut ou SQUARE-CLOUD-PLATFORM fonctionnent aussi. Toute autre valeur répond INVALID_FILTER.
string
Un unique type de contenu de réponse, tel que renvoyé dans la répartition content_types (Unknown = non classé).
string
Une unique catégorie de bot vérifié, telle que renvoyée dans la répartition bots (Unverified = trafic normal non-bot).

Réponse

Cette route peut renvoyer une réponse dans un format compressé, optimisant la transmission des données.
string
Indique si l’appel a réussi : success si c’est le cas, error sinon.
object
Chaque répartition est un tableau de buckets. type identifie la dimension, visits correspond aux visiteurs uniques, requests au nombre de requêtes, bytes aux octets de réponse servis, et date au début de la fenêtre de 15 minutes. Les répartitions ips, status_codes, bots et content_types sont des totaux de fenêtre (top-N sur l’ensemble de la fenêtre) et ne comportent pas de champ date. Renvoie un objet vide ({}) lorsque la fenêtre demandée commence avant la date de création de l’application.

Erreurs courantes

Voir aussi