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 requêtes sont limitées à un seul site_id ; les points de terminaison de traçage utilisent 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 soit un site_id, soit, pour les points de terminaison de traçage, un tableau site_ids. Pour une référence complète et générée automatiquement de chaque point de terminaison, requête et type de réponse, consultez la référence de l’API REST.

Réponses d’erreur

Tout point de terminaison peut renvoyer ces réponses non-2xx :

Enveloppe 422

Chaque réponse 422 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 : un objet optionnel dont la forme dépend de error.
Un slug que vous pourrez rencontrer est legacy_log_query_syntax, renvoyé lorsqu’une requête de journaux utilise l’ancienne syntaxe attributes.<name>_<type>. Voir requêtes de journaux pour le langage de requête actuel.

Points de terminaison

Métriques

Voir la référence des métriques.

Traçage

Voir la référence de traçage.

Journaux

Voir la référence des journaux.

Kubernetes

Voir la référence Kubernetes.

Déploiements

Voir la référence des déploiements.

Check-ins

Voir la référence des check-ins.

Visuels enregistrés

Les points de terminaison des visuels enregistrés ne nécessitent pas d’authentification. Voir la référence des visuels enregistrés.

Système