Basis-URL
Alle eindpunten worden geserveerd onder/api/v2 op het domein appsignal.com:
Authenticatie
Verzoeken worden geauthenticeerd met uw persoonlijke API-token, meegestuurd als bearer-token of als query-parameter. U vindt uw token in het scherm met persoonlijke instellingen.site_id; tracing-eindpunten gebruiken
een site_ids-array zodat ze over meerdere sites kunnen zoeken. De API controleert of
uw token toegang heeft tot elke opgevraagde site voordat er gegevens worden geretourneerd. Om een
token zelf te verifiëren, roept u GET /api/v2/auth aan.
Uw site_id is de ID in de URL van uw app:
https://appsignal.com/<organization>/sites/<SITE_ID>. Voor logqueries heeft u ook
een log source-ID nodig — zie uw site- en bron-ID’s
vinden.
Een token verifiëren
message die het geauthenticeerde gebruikers-ID bevestigt.
Verzoeken en responses
De meeste eindpunten gebruikenPOST met een JSON-body en retourneren JSON. Alleen-lezen-opzoekingen
(zoals het opsommen van metric-namen) gebruiken GET met padparameters. Stel
Content-Type: application/json in op verzoeken met een body.
Tijden zijn ISO 8601-strings. De meeste querybodies nemen een from- en to-tijdsbereik
plus ofwel een site_id of, voor tracing-eindpunten, een site_ids-array.
Voor een volledige, automatisch gegenereerde referentie van elk eindpunt, verzoek en responstype,
zie de REST API-referentie.
Foutresponses
Elk eindpunt kan deze niet-2xx-responses retourneren:| Status | Betekenis | Body |
|---|---|---|
401 | Ontbrekende of ongeldige token | { "error": "Unauthorized" } |
404 | Route of resource niet gevonden | { "error": "Not found" } |
422 | Verzoek geparsed maar kan niet worden verwerkt | Foutenvelop (zie de volgende sectie) |
500 | Onafgehandelde server-side fout | { "error": "<message>" } |
422-envelop
Elke422-response gebruikt dezelfde envelop, zodat u ze op één plek kunt afhandelen:
error: een stabiele, machineleesbare slug. Vertak hierop in uw code.message: een menselijk leesbare boodschap, veilig om weer te geven.details: een optioneel object waarvan de vorm afhangt vanerror.
legacy_log_query_syntax, geretourneerd wanneer een logs-
query gebruikmaakt van de verouderde syntax attributes.<name>_<type>. Zie logs
opvragen voor de huidige querytaal.
Eindpunten
Metrics
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/metrics/timeseries | Metricgegevens opvragen als timeseries |
POST | /api/v2/metrics/list | Geaggregeerde metricgegevens opvragen als lijst met groepering |
GET | /api/v2/metrics/names/{site_id} | Alle metric-namen voor een site opsommen |
GET | /api/v2/metrics/type_and_tags/{site_id}/{metric_name} | Type en beschikbare tags van een metric ophalen |
Tracing
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/tracing/locator | Een trace lokaliseren over sites op trace-ID |
POST | /api/v2/tracing/trace | Alle spans voor een trace ophalen |
POST | /api/v2/tracing/trace/performance | Spans voor een performance-trace ophalen |
POST | /api/v2/tracing/trace/error | Spans voor een error-trace ophalen |
POST | /api/v2/tracing/traces/performance | Performance-traces opsommen |
POST | /api/v2/tracing/traces/errors | Error-traces opsommen |
POST | /api/v2/tracing/actions | Performance-acties met geaggregeerde metrics opsommen |
POST | /api/v2/tracing/action_edges | Upstream- en downstream-edges voor een actie opsommen |
POST | /api/v2/tracing/site_edges | Edges voor service-afhankelijkheden voor een site opsommen |
POST | /api/v2/tracing/slow_events | Trage events met geaggregeerde stats opsommen |
POST | /api/v2/tracing/slow_events/actions | Acties gerelateerd aan een traag event opsommen |
Logs
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/logs/lines | Logregels doorzoeken |
Kubernetes
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/kubernetes/nodes | Node-metrics opvragen |
POST | /api/v2/kubernetes/pods | Pod-metrics opvragen |
POST | /api/v2/kubernetes/pods/overview | Pod-overzicht met labels en status opvragen |
Deploys
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/deploys/stats | Deploy-statistieken voor een revisie ophalen |
Check-ins
| Methode | Pad | Beschrijving |
|---|---|---|
POST | /api/v2/check_ins/test_cron | Een cron-schema-expressie testen en valideren |
Opgeslagen visuals
| Methode | Pad | Beschrijving |
|---|---|---|
GET | /api/v2/saved_visuals/{id} | Een opgeslagen visual ophalen als JSON |
GET | /api/v2/saved_visuals/{id}/csv | Een opgeslagen visual downloaden als CSV |
Systeem
| Methode | Pad | Beschrijving |
|---|---|---|
GET | /api/v2/auth | Verifiëren of een token geldig is |