Passer au contenu principal
L’API publique (V2) est une API REST permettant de lire les données brutes des applications : métriques, traces, journaux, métriques Kubernetes et statistiques de déploiement. Elle complète l’API GraphQL, qui gère les modèles tels que les apps, les incidents, les tableaux de bord et les alertes. En règle générale, utilisez l’API REST pour lire les données et l’API GraphQL pour gérer la configuration.
Si vous créez un agent ou un assistant IA, AppSignal MCP expose ces données directement aux agents — vous n’avez peut-être pas besoin d’appeler cette API vous-même.

URL de base

Tous les points de terminaison sont servis sous /api/v2 sur le domaine appsignal.com :

Authentification

Les requêtes sont authentifiées avec votre jeton d’API personnel, transmis soit en tant que jeton bearer, soit en tant que paramètre de requête. Vous pouvez trouver votre jeton dans l’écran des paramètres personnels.
Votre jeton donne accès aux mêmes sites et organisations que ceux que vous pouvez voir dans AppSignal. La plupart des points de terminaison prennent un seul site_id. Certains points de terminaison de trace prennent plutôt un tableau site_ids, afin de pouvoir effectuer des recherches sur plusieurs sites. L’API vérifie que votre jeton a accès à chaque site demandé avant de renvoyer les données. Pour vérifier un jeton lui-même, appelez GET /api/v2/auth. Votre site_id est l’ID figurant dans l’URL de votre app : https://appsignal.com/<organization>/sites/<SITE_ID>. Pour les requêtes de journaux, vous avez également besoin d’un ID de source de journal — voir trouver vos IDs de site et de source.

Vérifier un jeton

Renvoie un objet JSON avec un message confirmant l’ID de l’utilisateur authentifié.

Requêtes et réponses

La plupart des points de terminaison utilisent POST avec un corps JSON et renvoient du JSON. Les recherches en lecture seule (telles que la liste des noms de métriques) utilisent GET avec des paramètres de chemin. Définissez Content-Type: application/json sur les requêtes comportant un corps. Les heures sont des chaînes ISO 8601. La plupart des corps de requête prennent une plage temporelle from et to plus un site_id ou un tableau site_ids. Les points de terminaison Kubernetes et d’arêtes de services traitent to comme exclusif.

Référence lisible par machine

/api/v2/openapi.json est la spécification OpenAPI 3.1 de l’API, générée à partir du code de l’API. Elle ne nécessite aucun jeton. Utilisez-la pour générer un client d’API, ou pour importer l’API dans des outils qui lisent OpenAPI. Les pages de référence des points de terminaison de cette documentation sont construites à partir d’elle.

Réponses d’erreur

Tout point de terminaison peut renvoyer ces réponses non-2xx : Les requêtes de trace, de recherche et de journaux sont limitées à quelques-unes à la fois par utilisateur. Sur les points de terminaison de liste de traces, un 429 peut aussi inclure une suggestion : une façon plus rapide d’écrire le filtre de la requête. Voir Lister les traces.

Enveloppe d’erreur

Chaque réponse 400 utilise la même enveloppe, vous pouvez donc les gérer en un seul endroit :
  • error : un slug stable et lisible par machine. Branchez-vous dessus dans votre code.
  • message : un message lisible par l’humain, sûr à afficher.
  • details : des données optionnelles dont la forme dépend de error.
Certaines pages de référence listent les slugs propres à un point de terminaison. Par exemple, paginer une liste de métriques renvoie pagination_invalid_per_page pour un per_page hors limites. Voir Paginer une liste.

Points de terminaison

Métriques

Pour savoir comment les utiliser, consultez Requêtes de métriques.

Traçage

Pour savoir comment les utiliser, consultez Requêtes de traces.

Journaux

Pour le langage de requête, consultez Requêtes de journaux. Pour la syntaxe de requête, consultez Rechercher des traces.

Événements

Pour savoir comment l’utiliser, consultez Principaux événements par groupe.

Kubernetes

Déploiements

Check-ins

Visuels enregistrés

Les points de terminaison des visuels enregistrés ne nécessitent pas d’authentification.

Système