Pular para o conteúdo principal
A API pública (V2) é uma API REST para ler dados brutos da aplicação: métricas, traces, logs, métricas de Kubernetes e estatísticas de deploy. Ela complementa a API GraphQL, que gerencia modelos como apps, incidentes, dashboards e alertas. Como regra geral, use a API REST para ler dados e a API GraphQL para gerenciar configuração.
Se você está construindo um agente ou assistente de IA, o AppSignal MCP expõe esses dados diretamente aos agentes — você pode não precisar chamar esta API por conta própria.

URL base

Todos os endpoints são servidos sob /api/v2 no domínio appsignal.com:

Autenticação

As requisições são autenticadas com seu token pessoal de API, passado como bearer token ou como parâmetro de query. Você pode encontrar seu token na tela de configurações pessoais.
Seu token dá acesso aos mesmos sites e organizações que você vê na AppSignal. A maioria dos endpoints recebe um único site_id. Alguns endpoints de trace recebem um array site_ids em vez disso, para que possam buscar em vários sites. A API verifica se seu token tem acesso a todos os sites solicitados antes de retornar dados. Para verificar o próprio token, chame GET /api/v2/auth. Seu site_id é o ID na URL do seu app: https://appsignal.com/<organization>/sites/<SITE_ID>. Para queries de log você também precisa de um ID de fonte de log — veja encontrando seus IDs de site e fonte.

Verificar um token

Retorna um objeto JSON com uma message confirmando o ID do usuário autenticado.

Requisições e respostas

A maioria dos endpoints usa POST com um corpo JSON e retorna JSON. Consultas somente leitura (como listar nomes de métricas) usam GET com parâmetros de path. Defina Content-Type: application/json em requisições com corpo. Horários são strings ISO 8601. A maioria dos corpos de query recebe um intervalo de tempo from e to mais um site_id ou um array site_ids. Os endpoints de Kubernetes e de edges de serviço tratam to como exclusivo.

Referência legível por máquina

/api/v2/openapi.json é a especificação OpenAPI 3.1 da API, gerada a partir do código da API. Ela não precisa de token. Use-a para gerar um cliente de API ou para importar a API em ferramentas que leem OpenAPI. As páginas de referência de endpoints desta documentação são construídas a partir dela.

Respostas de erro

Qualquer endpoint pode retornar estas respostas não-2xx: Requisições de trace, busca e log são limitadas a algumas por vez por usuário. Nos endpoints de listagem de traces, um 429 também pode incluir uma suggestion: uma forma mais rápida de escrever o filtro da requisição. Veja Listar traces.

Envelope de erro

Toda resposta 400 usa o mesmo envelope, para que você possa tratá-las em um único lugar:
  • error: um slug estável, legível por máquina. Faça branching com base nele em seu código.
  • message: uma mensagem legível por humanos, segura para exibir.
  • details: dados opcionais cujo formato depende de error.
Algumas páginas de referência listam os slugs próprios de um endpoint. Por exemplo, paginar uma lista de métricas retorna pagination_invalid_per_page para um per_page fora do intervalo. Veja Paginar uma lista.

Endpoints

Métricas

Para saber como usá-los, veja Consultando métricas.

Tracing

Para saber como usá-los, veja Consultando traces.

Logs

Para a linguagem de query, veja Consultando logs. Para a sintaxe de query, veja Buscar traces.

Eventos

Para saber como usá-lo, veja Principais eventos por grupo.

Kubernetes

Deploys

Check-ins

Visuais salvos

Os endpoints de visual salvo não exigem autenticação.

Sistema