Método HTTP GET
Autenticação: API Key + API Secret
Agregações
Agregações por categoria
Retorna métricas agregadas por categoria de veículo, incluindo quantidade de veículos, consumo médio, emissão média e eco score médio.
Resumo técnico
- Método
- Método HTTP GET
- Rota
- /aggregations/by-category
- URL completa
- https://uzjxyrtbszreqxjvpzpv.supabase.co/functions/v1/public-catalog-phase1/aggregations/by-category
Quando usar
Use para consolidar métricas entre Sedan, SUV etc.
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 |
Parâmetros de consulta
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| marca | string | Não | Filtra por marca (ilike). | - |
| modelo | string | Não | Filtra por modelo (ilike). | - |
| categoria | string | Não | Filtra por categoria (ilike). | - |
| combustivel | string | Não | Filtra por combustível (ilike). | - |
| propulsao | string | Não | Filtra por tipo de propulsão (ilike). | - |
| transmissao | string | Não | Filtra por transmissão (ilike). | - |
| ano | number | Não | Ano exato (1900-2100); equivalente a ano_min=<ano>&ano_max=<ano>. | 2023 |
| ano_min | number | Não | Ano mínimo (1900-2100). | 2020 |
| ano_max | number | Não | Ano máximo (1900-2100). | 2026 |
Campos principais da resposta
Retorna categorias em `data.data.items`, com métricas agregadas por grupo, além de metadados em `data.meta`.
| Nome | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| data.data.items[] | string | Não | Campo retornado pelo endpoint. | - |
| data.data.items[].grupo | string | Não | Campo retornado pelo endpoint. | - |
Cenários de uso
- Alimentar dashboards com `data.data.items` por grupo (brand/year/fuel/category).
- Usar endpoints de distribuição para histogramas (`faixa`, `total`).
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/aggregations/by-category" \
-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": [
{
"grupo": "SUV",
"quantidadeVeiculos": 2500,
"consumoMedio": 2.02,
"emissaoMedia": 128.3,
"ecoScoreMedio": 47.8
}
]
},
"meta": {
"generated_at": "2026-04-17T22:03:16.372Z",
"request_id": "762f6abe-1846-4c04-a979-e348c3e0c072",
"filters_applied": {}
}
}
}Erros possíveis (exemplo de payload)
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Parâmetros inválidos: page deve ser maior que 0"
}
}