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.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
message confirmant l’ID de l’utilisateur
authentifié.
Requêtes et réponses
La plupart des points de terminaison utilisentPOST 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 :| Statut | Signification | Corps |
|---|---|---|
401 | Jeton manquant ou invalide | { "error": "Unauthorized" } |
404 | Route ou ressource introuvable | { "error": "Not found" } |
422 | Requête analysée mais impossible à traiter | Enveloppe d’erreur (voir la section suivante) |
500 | Échec côté serveur non géré | { "error": "<message>" } |
Enveloppe 422
Chaque réponse422 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 deerror.
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
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/metrics/timeseries | Interroger les données de métriques sous forme de série temporelle |
POST | /api/v2/metrics/list | Interroger les données de métriques agrégées sous forme de liste avec regroupement |
GET | /api/v2/metrics/names/{site_id} | Lister tous les noms de métriques pour un site |
GET | /api/v2/metrics/type_and_tags/{site_id}/{metric_name} | Obtenir le type d’une métrique et les tags disponibles |
Traçage
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/tracing/locator | Localiser une trace à travers les sites par ID de trace |
POST | /api/v2/tracing/trace | Obtenir tous les spans d’une trace |
POST | /api/v2/tracing/trace/performance | Obtenir les spans d’une trace de performance |
POST | /api/v2/tracing/trace/error | Obtenir les spans d’une trace d’erreur |
POST | /api/v2/tracing/traces/performance | Lister les traces de performance |
POST | /api/v2/tracing/traces/errors | Lister les traces d’erreur |
POST | /api/v2/tracing/actions | Lister les actions de performance avec métriques agrégées |
POST | /api/v2/tracing/action_edges | Lister les arêtes amont et aval pour une action |
POST | /api/v2/tracing/site_edges | Lister les arêtes de dépendances de services pour un site |
POST | /api/v2/tracing/slow_events | Lister les événements lents avec statistiques agrégées |
POST | /api/v2/tracing/slow_events/actions | Lister les actions liées à un événement lent |
Journaux
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/logs/lines | Rechercher des lignes de journal |
Kubernetes
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/kubernetes/nodes | Interroger les métriques de nœud |
POST | /api/v2/kubernetes/pods | Interroger les métriques de pod |
POST | /api/v2/kubernetes/pods/overview | Interroger la vue d’ensemble des pods avec labels et statut |
Déploiements
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/deploys/stats | Obtenir les statistiques de déploiement pour une révision |
Check-ins
| Méthode | Chemin | Description |
|---|---|---|
POST | /api/v2/check_ins/test_cron | Tester et valider une expression de planification cron |
Visuels enregistrés
| Méthode | Chemin | Description |
|---|---|---|
GET | /api/v2/saved_visuals/{id} | Récupérer un visuel enregistré au format JSON |
GET | /api/v2/saved_visuals/{id}/csv | Télécharger un visuel enregistré au format CSV |
Système
| Méthode | Chemin | Description |
|---|---|---|
GET | /api/v2/auth | Vérifier qu’un jeton est valide |