Metrics
Métricas do Olist pela API
Seu cliente conecta a conta do Olist e seu produto consulta 7 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"comparison_start": "2026-09-01",
"comparison_end": "2026-09-30",
"metrics": [
{
"id": "m1",
"reference_key": "olist:total_orders",
"component": "number_v1",
"metrics": [
"orders"
],
"dimensions": [
"summary"
]
}
]
}Mais exemplos de chamadas no Olist
O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).
Gráfico
Pedidos ao longo do tempo
Evolução diária dos pedidos. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "olist:orders_over_time",
"component": "chart_v1",
"metrics": [
"orders"
],
"dimensions": [
"date"
]
}
]
}Tabela
Pedidos por situação
Distribuição de pedidos e valor de vendas agrupados por situação do pedido. Mostra todas as situações, incluindo em aberto, cancelados e com dados incompletos.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "olist:orders_by_status",
"component": "datatable_v1",
"metrics": [
"orders",
"total_value"
],
"dimensions": [
"status"
]
}
]
}Número
Total de vendas
Soma dos totais dos pedidos no período selecionado. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão, seguindo o padrão do dashboard da Olist.
POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
{
"customer_integration": "<connection uuid>",
"start": "2026-10-01",
"end": "2026-10-31",
"metrics": [
{
"id": "m1",
"reference_key": "olist:total_sales",
"component": "number_v1",
"metrics": [
"total_value"
],
"dimensions": [
"summary"
]
}
]
}Números
4 métricas
Total de pedidos
Número total de pedidos no período selecionado. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão, seguindo o padrão do dashboard da Olist.
olist:total_ordersTotal de vendas
Soma dos totais dos pedidos no período selecionado. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão, seguindo o padrão do dashboard da Olist.
olist:total_salesTicket Médio
Valor médio de vendas por pedido no período selecionado. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão.
olist:average_ticketPedidos cancelados
Número total de pedidos cancelados no período selecionado.
olist:canceled_orders
Gráficos
2 métricas
Pedidos ao longo do tempo
Evolução diária dos pedidos. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão.
olist:orders_over_timeVendas ao longo do tempo
Evolução diária do valor total de vendas. Exclui pedidos em aberto, cancelados e com dados incompletos por padrão.
olist:sales_over_time
Tabelas
1 métrica
Pedidos por situação
Distribuição de pedidos e valor de vendas agrupados por situação do pedido. Mostra todas as situações, incluindo em aberto, cancelados e com dados incompletos.
olist:orders_by_status
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
