Método HTTP GET
Autenticação: API Key + API Secret
Rankings
Visão geral dos rankings
Lista consolidada com ranking_tipo e métricas por veículo.
Resumo técnico
- Método
- Método HTTP GET
- Rota
- /rankings/overview
- URL completa
- https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/rankings/overview
Quando usar
Use em dashboards que mostram múltiplos rankings em uma chamada.
Headers obrigatórios
| Header | Obrigatório | Descrição | Exemplo |
|---|---|---|---|
| X-API-Key | Sim | Chave pública fornecida para consumo da API pública. | SUA_PUBLIC_KEY |
| X-API-Secret | Sim | Segredo pareado à API Key para autenticação. | SEU_SECRET |
Campos principais da resposta
Retorna `data.data.items[]` com `ranking_tipo`, `ranking_posicao`, `metrica_valor` e `metrica_unidade`.
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| data.data.items[].ranking_tipo | string | Não | Campo retornado pelo endpoint. | - |
| data.data.items[].ranking_posicao | string | Não | Campo retornado pelo endpoint. | - |
| data.data.items[].vehicle_id | string | Não | Campo retornado pelo endpoint. | - |
| data.data.items[].metrica_valor | string | Não | Campo retornado pelo endpoint. | - |
| data.data.items[].metrica_unidade | string | Não | Campo retornado pelo endpoint. | - |
Cenários de uso
- Exibir rankings específicos (most-economical, lowest-co2, electric-range) usando `ranking_type` + `items`.
- Gerar ranking customizado/segmentado consumindo `filters_applied` do meta.
Exemplos de integração
Os exemplos desta documentação utilizam dados fictícios/mockados para fins ilustrativos, mas seguem a estrutura oficial real da API.
Nunca exponha X-API-Secret em aplicações front-end públicas. Para aplicações web públicas, faça a chamada a partir do seu backend.
Exemplo de integração (cURL)
curl -X GET "https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/rankings/overview" \
-H "X-API-Key: SUA_PUBLIC_KEY" \
-H "X-API-Secret: SEU_SECRET"Os exemplos desta documentação utilizam dados fictícios/mockados para fins ilustrativos, mas seguem a estrutura oficial real da API.
Exemplo de resposta
{
"success": true,
"data": {
"data": {
"items": [
{
"ranking_tipo": "mais-economicos",
"ranking_posicao": 1,
"vehicle_id": "001af754-592a-42ce-8227-01c958d4de3c",
"marca": "BYD",
"modelo": "Dolphin",
"versao": "GS EV",
"ano": 2026,
"categoria": "Hatch",
"tipo_propulsao": "Elétrico",
"combustivel_tipo": "Elétrico",
"metrica_valor": 18.5,
"metrica_unidade": "km/unidade"
}
]
},
"meta": {
"generated_at": "2026-04-17T22:03:16.372Z",
"request_id": "762f6abe-1846-4c04-a979-e348c3e0c072"
}
}
}Erros possíveis (exemplo de payload)
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Parâmetros inválidos: page deve ser maior que 0"
}
}