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:| Status | Meaning | Body |
|---|---|---|
401 | Missing or invalid token | { "error": "Unauthorized" } |
404 | Route or resource not found | { "error": "Not found" } |
422 | Request parsed but cannot be processed | Error envelope (see the following section) |
500 | Unhandled server-side failure | { "error": "<message>" } |
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
| Method | Path | Description |
|---|---|---|
POST | /api/v2/metrics/timeseries | Query metric data as a timeseries |
POST | /api/v2/metrics/list | Query aggregated metric data as a list with grouping |
GET | /api/v2/metrics/names/{site_id} | List all metric names for a site |
GET | /api/v2/metrics/type_and_tags/{site_id}/{metric_name} | Get a metric’s type and available tags |
Tracing
| Method | Path | Description |
|---|---|---|
POST | /api/v2/tracing/locator | Locate a trace across sites by trace ID |
POST | /api/v2/tracing/trace | Get all spans for a trace |
POST | /api/v2/tracing/trace/performance | Get spans for a performance trace |
POST | /api/v2/tracing/trace/error | Get spans for an error trace |
POST | /api/v2/tracing/traces/performance | List performance traces |
POST | /api/v2/tracing/traces/errors | List error traces |
POST | /api/v2/tracing/actions | List performance actions with aggregated metrics |
POST | /api/v2/tracing/action_edges | List upstream and downstream edges for an action |
POST | /api/v2/tracing/site_edges | List service dependency edges for a site |
POST | /api/v2/tracing/slow_events | List slow events with aggregated stats |
POST | /api/v2/tracing/slow_events/actions | List actions related to a slow event |
Logs
| Method | Path | Description |
|---|---|---|
POST | /api/v2/logs/lines | Search log lines |
Kubernetes
| Method | Path | Description |
|---|---|---|
POST | /api/v2/kubernetes/nodes | Query node metrics |
POST | /api/v2/kubernetes/pods | Query pod metrics |
POST | /api/v2/kubernetes/pods/overview | Query pod overview with labels and status |
Deploys
| Method | Path | Description |
|---|---|---|
POST | /api/v2/deploys/stats | Get deploy statistics for a revision |
Check-ins
| Method | Path | Description |
|---|---|---|
POST | /api/v2/check_ins/test_cron | Test and validate a cron schedule expression |
Saved visuals
| Method | Path | Description |
|---|---|---|
GET | /api/v2/saved_visuals/{id} | Retrieve a saved visual as JSON |
GET | /api/v2/saved_visuals/{id}/csv | Download a saved visual as CSV |
System
| Method | Path | Description |
|---|---|---|
GET | /api/v2/auth | Verify that a token is valid |