Passer au contenu principal
Lisez les données de métriques avec l’API publique (V2). Récupérez une série temporelle pour des graphiques, une liste agrégée pour des tableaux, ou découvrez quelles métriques et tags possède un site. Tous les points de terminaison s’authentifient avec votre jeton d’API personnel et sont limités à un seul site_id.

Interroger une série temporelle

Ce point de terminaison renvoie une ou plusieurs séries de points de données sur une plage temporelle. Utilisez-le pour dessiner des graphiques.
POST /api/v2/metrics/timeseries

Corps de la requête

ChampTypeObligatoireDescription
site_idchaîneOuiSite à interroger.
fromchaîne (ISO 8601)OuiDébut de la plage temporelle (inclus).
tochaîne (ISO 8601)OuiFin de la plage temporelle (incluse).
selectTimeseriesSelector[]OuiQuelles métriques, champs et tags récupérer.
resolutionResolutionNonIntervalle entre les points de données. Choisi automatiquement lorsqu’omis.
limitnombreNonNombre maximum de séries à renvoyer.
Chaque entrée select prend un name de métrique, un objet tags sur lequel filtrer (les valeurs peuvent utiliser * comme caractère générique), un field (voir champs), une aggregation optionnelle (voir agrégations), et draw_null_as_zero (lorsque true, les points manquants sont remplis avec 0).
{
  "site_id": "YOUR-SITE-ID",
  "from": "2026-06-22T00:00:00Z",
  "to": "2026-06-22T01:00:00Z",
  "resolution": "MINUTELY",
  "select": [
    {
      "name": "transaction_duration",
      "tags": { "namespace": "web" },
      "field": "mean",
      "aggregation": "avg",
      "draw_null_as_zero": false
    }
  ],
  "limit": null
}

Réponse

Renvoie un Timeseries avec la resolution, from, to interrogées et un tableau series. Chaque série possède un id, le name de la métrique, ses tags, le field qu’elle représente, min et max sur la plage, et un tableau data de points. Chaque point a un timestamp et une value numérique.

Interroger une liste

Ce point de terminaison renvoie des valeurs de métriques agrégées regroupées en lignes. Utilisez-le pour créer des tableaux.
POST /api/v2/metrics/list

Corps de la requête

ChampTypeObligatoireDescription
site_idchaîneOuiSite à interroger.
fromchaîne (ISO 8601)OuiDébut de la plage temporelle (inclus).
tochaîne (ISO 8601)OuiFin de la plage temporelle (incluse).
selectListSelector[]OuiQuelles métriques, champs et tags récupérer.
group_byGroupBy[]OuiComment regrouper les lignes.
resolutionResolutionNonIntervalle utilisé pour l’agrégation.
limitnombreNonNombre maximum de lignes à renvoyer.
Un ListSelector est comme un sélecteur de séries temporelles, avec un id supplémentaire qui nomme la valeur du sélecteur dans l’objet data de chaque ligne. Les entrées group_by sont Name (regrouper par nom de métrique) ou Tag (regrouper par valeur de tag).
{
  "site_id": "YOUR-SITE-ID",
  "from": "2026-06-22T00:00:00Z",
  "to": "2026-06-22T01:00:00Z",
  "resolution": "HOURLY",
  "select": [
    {
      "id": "mean",
      "name": "transaction_duration",
      "tags": { "namespace": "*" },
      "field": "mean",
      "aggregation": "avg"
    }
  ],
  "group_by": ["Name"],
  "limit": 50
}

Réponse

Renvoie une List avec la resolution, from, to interrogées et un tableau rows. Chaque ligne a un id, un objet group des valeurs de tags qui la définissent, et un objet data de valeurs agrégées indexées par id de sélecteur (par exemple, { "mean": 42.5 }).

Lister les noms de métriques

Renvoie chaque nom de métrique disponible pour un site.
GET /api/v2/metrics/names/{site_id}
Renvoie un tableau de chaînes.

Obtenir le type et les tags d’une métrique

Renvoie le type d’une métrique et les combinaisons de tags avec lesquelles elle peut être interrogée.
GET /api/v2/metrics/type_and_tags/{site_id}/{metric_name}
Renvoie un metric_type (gauge, counter ou measurement) et available_tags, un tableau où chaque entrée est une combinaison valide de clés de tag.

Référence

Champs

Le field sélectionne quelle mesure récupérer à partir d’une métrique :
ValeurDescription
gaugeLa valeur de la métrique à un moment donné, telle que l’utilisation actuelle du CPU ou de la mémoire.
counterÀ partir des métriques counter, la valeur cumulée, qui augmente uniquement au fil du temps, comme le nombre de requêtes servies.
meanLa moyenne des valeurs enregistrées dans l’intervalle temporel, comme le temps de réponse moyen.
countÀ partir des métriques measurement, combien de valeurs ont été enregistrées pendant l’intervalle temporel.
minLa valeur la plus basse enregistrée dans l’intervalle temporel.
maxLa valeur la plus haute enregistrée dans l’intervalle temporel.
p_90, p_95Valeurs de percentile.
Pour plus de références sur les types, lisez la documentation de l’API V2 d’AppSignal.

Agrégations

L’aggregation combine plusieurs valeurs dans un intervalle temporel : sum, avg, min, max, first ou last.

Résolutions

resolution accepte MINUTELY, FIVE_MINUTELY, TEN_MINUTELY, FIFTEEN_MINUTELY, HOURLY ou DAILY.