Base URL
All endpoints are served under/api/v2 on the appsignal.com domain:
Authentication
Requests are authenticated with your personal API token, passed either as a bearer token or as a query parameter. You can find your token in the personal settings screen.site_id; tracing endpoints use
a site_ids array so they can search across multiple sites. The API checks that
your token has access to every requested site before returning data. To verify a
token itself, call GET /api/v2/auth.
Your site_id is the ID in your app’s URL:
https://appsignal.com/<organization>/sites/<SITE_ID>. For log queries you also
need a log source ID — see finding your site and source
IDs.
Verify a token
message confirming the authenticated user ID.
Requests and responses
Most endpoints usePOST with a JSON body and return JSON. Read-only lookups
(such as listing metric names) use GET with path parameters. Set
Content-Type: application/json on requests with a body.
Times are ISO 8601 strings. Most query bodies take a from and to time range
plus either a site_id or, for tracing endpoints, a site_ids array.
For a complete, auto-generated reference of every endpoint, request, and response
type, see the REST API reference.
Error responses
Any endpoint can return these non-2xx responses:422 envelope
Every422 response uses the same envelope, so you can handle them in one place:
error: a stable, machine-readable slug. Branch on this in your code.message: a human-readable message, safe to display.details: an optional object whose shape depends onerror.
legacy_log_query_syntax, returned when a logs
query uses the legacy attributes.<name>_<type> syntax. See querying
logs for the current query language.
Endpoints
Metrics
See the metrics reference.
Tracing
See the tracing reference.
Logs
See the logs reference.
Kubernetes
See the Kubernetes reference.
Deploys
See the deploys reference.
Check-ins
See the check-ins reference.
Saved visuals
Saved visual endpoints do not require authentication. See the saved visuals
reference.