VolundOS
Referência da APILeaderboard

Ler o ranking de consumo da organização da chave

O lado servidor do Leaderboard multi-org: a organização que emitiu esta chave expõe por aqui o próprio ranking de consumo, para que outra organização possa incluí-lo no painel dela. Não há parâmetro de organização: a chave pertence a uma, e é dela que se fala. O ranking é lido com a permissão de QUEM EMITIU a chave — o que sai daqui é o que essa pessoa vê no próprio painel, nem mais nem menos. Responde 404 quando a organização desligou o leaderboard em Configurações: a decisão vale para os dados, e não só para a tela. Exige o escopo leaderboard:read.

Atualizado em 25 de setembro de 2026
GET
/v1/leaderboard

Authorization

chaveDeApi
AuthorizationBearer <token>

Chave de API da organização, criada nas configurações. Envie-a em Authorization: Bearer <sua chave>.

In: header

Query Parameters

period?string

Janela: today, this_month (padrão), last_month, 7d, 30d, 90d ou all. Valor desconhecido é 400, e não um padrão silencioso.

axis?string

Eixo do ranking: people (padrão), systems ou teams.

origins?string

Lista separada por vírgula entre native, external, router e claude_code. Ausente traz as quatro; vazia é uma escolha legítima e zera tudo.

Response Body

application/json

curl -X GET "https://example.com/v1/leaderboard"
{  "org": {},  "totals": {},  "ranking": [    {}  ],  "timeseries": [    {}  ],  "external": {},  "axis": "string",  "period": "string",  "origins": [    "string"  ],  "start": "string",  "end": "string",  "externalFrom": "string",  "externalTo": "string"}