Pular para o conteúdo principal
Consulte URLs e autenticação HTTP e a referência da API para os formatos completos de solicitação e resposta. A Telemetry API responde a perguntas sobre uso, custo, latência, traces e logs a partir de um único endpoint. Toda solicitação informa uma source, um intervalo de tempo e uma ou mais entradas compute, e todas as fontes respondem com o mesmo formato de linha.
A Telemetry API é a superfície de consulta recomendada para novas integrações: um único envelope abrange métricas de uso, agregados de traces e logs. A Reporting API está obsoleta em favor dela. Os endpoints de agregados de traces continuam com suporte para os chamadores existentes.

Uso e custo

Agrupe métricas genai por modelo, provedor, projeto, agent ou tool.

Agregados de traces

Conte traces e spans e obtenha percentis de latência ou totais de tokens e custo.

Volume de logs

Conte registros de log e registros de erro, agrupados por severidade ou serviço.

Descubra a superfície

Liste as métricas, operações e dimensões que o chamador pode acessar.

Endpoint

POST https://router.toqan.ai/eu/v3/telemetry/query
  • Todas as solicitações exigem um token Bearer. Consulte API Keys para saber como gerar um.
  • O escopo de workspace e projeto vem da chave de API.

Consultar telemetria

Esquema completo de POST /v3/telemetry/query.

Listar capacidades

GET /v3/telemetry/capabilities.

Listar valores de facetas

POST /v3/telemetry/facet-values.

Início rápido

Conte as solicitações por modelo no último dia:

Solicitação

auto determina a largura do bucket a partir do intervalo solicitado, e a escala depende da fonte:

Resposta

Todas as fontes respondem com o mesmo envelope:
Envelope
  • As chaves de metrics são a métrica e a operação solicitadas unidas por dois-pontos, por exemplo trace_count:count ou genai.cost:sum.
  • timestamp está presente apenas em linhas agrupadas em buckets.
  • totals aparece apenas quando a solicitação define include_totals: true e não traz timestamp, com um group vazio.
  • meta.effective_grain informa o bucket efetivamente aplicado, incluindo as larguras às quais interval_seconds ou auto foram resolvidos. meta.currency é USD somente quando todas as entradas compute são genai.cost, e fica vazio em qualquer outra consulta.
  • meta.warnings explica um valor que a fonte ignorou, por exemplo um time_zone enviado a uma fonte que agrupa em UTC.

Fontes e métricas

TELEMETRY_SOURCE_TRACES abrange agregados brutos de traces, as métricas de uso genai e as métricas de spans. Os três não podem ser misturados em uma única solicitação. As métricas de spans (gen_ai.* e orq.gen_ai.*) são calculadas por span de solicitação de LLM. Elas respeitam time_zone e aceitam vários computes em uma consulta escalar agrupada, ordenada pelo primeiro. TELEMETRY_SOURCE_METRICS abrange as métricas personalizadas registradas no workspace. TELEMETRY_SOURCE_LOGS abrange apenas registros de log. genai.usage é um pacote: solicite-o com op: "bundle" e ele retorna todos os campos em uma única linha, sob chaves genai.usage:<field>. Seus campos não são métricas consultáveis isoladamente, e esse compute não pode ser combinado com nenhum outro na mesma solicitação.

Descubra o que está disponível

As capacidades listam o que uma chave pode acessar, para que o cliente nunca precise fixar o vocabulário no código:
Cada entrada de métrica traz seu rótulo, unidade, operações, operação padrão, modos de consulta, tipos de resultado e as dimensões pelas quais pode ser agrupada, incluindo se cada dimensão é agrupável e quais operadores de filtro aceita. Os valores de facetas listam os valores distintos que um campo assume no workspace, para que um filtro possa ser criado a partir de dados reais. Apenas a fonte de traces é compatível: as fontes de métricas e logs respondem 501.

Exemplos por caso de uso

genai.cost soma o que foi registrado na janela, group_by divide por modelo e include_totals adiciona o total da janela:
Conte apenas os traces com falha. status aceita ok, error ou unset:
Uma top list escalar: sem grain, uma linha por tool, ordenada pela métrica:
A fonte de logs agrupa pelos campos do OpenTelemetry que armazena, e severity_text traz valores como INFO, WARN ou ERROR:
Obtenha a contagem de solicitações, os tokens e o custo em uma única chamada. Ideal para dashboards de visão geral.
A resposta traz group.credential_type como "orq_managed" ou "customer_byok".
A chave genai.latency.p95:p95 é informada em milissegundos.
Cada quantil é uma chamada separada. Dispare três solicitações simultâneas quando precisar dos três.
Busque as solicitações e os erros em paralelo e faça a divisão no cliente.
Os limites dos buckets se alinham à meia-noite no fuso solicitado.
O mesmo formato responde às perguntas sobre entidades: troque group_by por provider, product, base_model, project_id, tool_name ou agent_name em traces, service_name ou host_name em logs, e agent, tool ou project nas métricas de uso genai. As métricas de ttft, evaluator e guardrail não aceitam nenhuma dimensão de entidade além de project. Dimensões dinâmicas podem ser endereçadas por prefixo: attributes.* e metadata.* em traces, attribute.*, resource.* e scope.* em logs.

Valores de status de trace

Cada superfície nomeia os mesmos dois resultados de forma diferente. unset é um trace que terminou sem status de erro, e a visualização Traces o considera bem-sucedido.

Erros

Uma consulta rejeitada retorna um envelope JSON com um code numérico, uma message legível e um array details (as respostas 401 e 403 trazem apenas code e message):
Toda resposta de consulta bem-sucedida inclui meta.request_id. Inclua-o nos tickets de suporte para uma correlação rápida dos logs.
As rejeições por orçamento trazem um detalhe ErrorInfo que nomeia o recurso esgotado (range_days, buckets, rows, series ou metric_values) e seu limite; em todas as fontes, exceto métricas genai, um estouro de buckets também informa a quantidade necessária.

Limites