Este endpoint foi desenhado para o consumo de dados consolidados, ideal para alimentação de dashboards gerenciais e ferramentas de BI que não exigem o detalhamento técnico de cada captura individual (dado desagregado).
O acesso a este endpoint é restrito a clientes que possuem o produto ISA - Infopanel ativo em contrato.
Regras de Consumo e Performance
Para garantir a estabilidade do serviço e a performance nas consultas, a API segue as seguintes diretrizes:
Formato de Resposta: Os dados são entregues estritamente em formato JSON, seguindo o esquema padrão de agregação da InfoPrice.
Essa API é autenticada, acesse a seção de autenticação aqui
POST https://api.infopriceti.com.br/cliente/v1/painel_geral/agregado
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
page |
Número da página. O padrão se não enviado é 0 | int |
Não |
size |
Tamanho da página. O padrão se não enviado é 100 e o limite são 10000 | int |
Não |
| Parâmetro | Descrição | Formato | Obrigatório |
|---|---|---|---|
filter |
Objeto contendo os filtros a serem aplicados | json |
Sim |
group |
Lista contendo os campos agrupadores. Valores possíveis: CIDADE, UF, LOJA, REDE, TIPO_LOJA, DATA, GTIN |
string[] |
Sim |
order |
Tamanho da página. O padrão se não enviado é 100 e o limite são 10000 | json |
Sim |
Importante: Por motivos de performance, para ser possível agrupar por
GTIN, é necessário incluir um filtro de gtins (com até 5000 itens)
filter| Parâmetro | Descrição | Formato |
|---|---|---|
data_inicio |
Data início do preço (inclusive) | date (yyyy-MM-dd) |
data_fim |
Data fim do preço (inclusive) | date (yyyy-MM-dd) |
data_run |
Data de entrada do preço (data processamento) | date (yyyy-MM-dd) |
regiao |
Lista de regiões das lojas consulte dicionário de dados aqui | string[] |
uf |
Lista de Unidades Federativas das lojas. consulte dicionário de dados aqui | string[] |
cnpj |
Lista de cnpj da loja. Não deve ter traços e pontos | string[] |
cep |
CEP da loja | string |
latitude |
Latitude do Endereço | decimal |
longitude |
Longitude do Endereço | decimal |
raio |
Raio em kilômetros para filtrar lojas a partir do cep informado. Deve ser utilizado em conjunto com cep |
decimal |
cidade |
Lista de cidades da loja | string[] |
rede |
Lista de redes | string[] |
tipo_loja |
Lista de tipos de loja consulte dicionário de dados aqui | string[] |
categoria |
Lista de categorias. consulte dicionário de dados aqui | string[] |
secao |
Lista de seções. consulte dicionário de dados aqui | string[] |
marca |
Lista de marcas | string[] |
tipo_produto |
Lista de iipo de produto. Os valores possíveis são GTIN e GRANEL |
string[] |
fabricante |
Lista de fabricande de produto | string[] |
gtin |
Lista de código de barras | string[] |
preco |
Tipo de preço escolhido. Os valores possíveis são PRECO_PAGO ou PRECO_REGULAR |
string |
tipo_preco |
Lista de Tipos de Preço. Os valores possíveis são: Regular e Promoção | string[] |
origem_preco |
Lista de origem preço. consulte dicionário de dados aqui | string[] |
group"group": ["CIDADE", "LOJA"]
Valores possíveis
CIDADE |
UF |
REGIAO |
LOJA |
REDE |
TIPO_LOJA |
DATA |
FABRICANTE |
ORIGEM_PRECO |
GTIN |
SEMANA |
MES |
FONTE_DIGITAL |
order| Parâmetro | Descrição | Formato |
|---|---|---|
by |
Campo usado na ordenação | string |
ascending |
Define se é ascendente | boolean |
Valores possíveis no by
CIDADE |
UF |
LOJA |
REDE |
TIPO_LOJA |
DATA |
GTIN |
DESCRICAO |
SEMANA |
MES |
PRECO_PAGO |
PRECO_REGULAR |
DATAPOINTS |
PRECO_MINIMO |
PRECO_QUARTIL_INFERIOR |
MEDIANA |
PRECO_MODA |
PRECO_MEDIO |
PRECO_QUARTIL_SUPERIOR |
PRECO_MAXIMO |
REDES_DISTINTAS |
CNPJS_DISTINTOS |
FABRICANTE |
Authorization: cabeçalho contendo token obtido na request de autenticaçãoAuthorization: Bearer mytokenhere111111
curl --location --request POST 'https://api.infopriceti.com.br/cliente/v1/painel_geral/agregado?size=3' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/json' \
--data-raw '{
"filter": {
"data_inicio": "2022-05-01",
"data_fim": "2022-05-09",
"rede": ["25+ Conveniencia"],
"tipo_loja": ["Atacado"],
"cnpj": null,
"uf": ["SP"],
"cep": null,
"latitude": -22.9068467,
"longitude": -43.1728965,
"raio": 2,
"cidade": ["Acajutiba"],
"categoria": ["Bebidas"],
"secao": ["Bebidas"],
"gtin": [
"7891132082346"
],
"tipo_preco": ["Regular"],
"tipo_produto": ["GTIN"],
"origem_preco": ["Nota Fiscal"],
"fabricante": ["COCA COLA INDS LTDA"]
},
"group": [
"UF",
"TIPO_LOJA"
],
"order": [
{
"by": "MEDIANA", "ascending": true
}
]
}'
{
"content": [
{
"uf": "RJ",
"tipo_loja": "ATACADO",
"preco_medio": 3.7427272727272736,
"preco_moda": 3.49,
"preco_minimo": 2.99,
"preco_quartil_inferior": 3.49,
"preco_mediano": 3.49,
"preco_quartil_superior": 3.73,
"preco_maximo": 5.99,
"quantidade_datapoints": 11,
"cnpjs_distintos": 6,
"redes_distintas": 6
},
{
"uf": "BA",
"tipo_loja": "ATACADO",
"preco_medio": 4,
"preco_moda": 4,
"preco_minimo": 4,
"preco_quartil_inferior": 4,
"preco_mediano": 4,
"preco_quartil_superior": 4,
"preco_maximo": 4,
"quantidade_datapoints": 1,
"cnpjs_distintos": 1,
"redes_distintas": 1
},
{
"uf": "RN",
"tipo_loja": "ATACADO",
"preco_medio": 2.99,
"preco_moda": 2.99,
"preco_minimo": 2.99,
"preco_quartil_inferior": 2.99,
"preco_mediano": 2.99,
"preco_quartil_superior": 2.99,
"preco_maximo": 2.99,
"quantidade_datapoints": 2,
"cnpjs_distintos": 1,
"redes_distintas": 1
}
],
"pageable": {
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"pageNumber": 0,
"pageSize": 3,
"offset": 0,
"unpaged": false,
"paged": true
},
"last": false,
"totalElements": 35,
"totalPages": 12,
"first": true,
"sort": {
"sorted": false,
"unsorted": true,
"empty": true
},
"numberOfElements": 3,
"size": 3,
"number": 0,
"empty": false
}
Os campos abaixo detalhados estão dentro do objeto
content. O Conteúdo de retorno é relacionado às colunas de agregação. Por exemplo, caso o resultado seja agregado por Cidade, UF, e GTIN, as demais colunas de agregação não constarão no resultado.
| Campo | Agregação | Tipo |
|---|---|---|
data_preco |
data |
date |
dia_semana |
semana |
date |
dia_mes |
mes |
date |
regiao |
regiao |
string |
uf |
uf |
string |
cidade |
cidade |
string |
rede |
rede |
string |
tipo_loja |
tipo_loja |
string |
loja |
loja |
string |
cnpj |
loja |
string |
gtin |
gtin |
string |
descricao |
gtin |
string |
fabricante |
fabricante |
string |
origem_preco |
origem_preco |
string |
fonte_digital |
fonte_digital |
string |
preco_medio |
MÉDIA | decimal |
preco_moda |
MODA | decimal |
preco_minimo |
MINIMO | decimal |
preco_quartil_inferior |
ABAIXO DE 25% | decimal |
preco_mediano |
MEDIANA | decimal |
preco_quartil_superior |
CIMA DE 75% | decimal |
preco_maximo |
MAIOR | decimal |
quantidade_datapoints |
CONTAGEM | int |
cnpjs_distintos |
CONTAGEM DISTINTA | int |
redes_distintas |
CONTAGEM DISTINTA | int |
Essa API conta com recurso de paginação padrão Infoprice. Você pode consultar mais detalhes da paginação aqui
O dicionáro de dados pode ser consultado aqui