Metrics

Métricas de Olist con la API

Tu cliente conecta su cuenta de Olist y tu producto consulta 7 métricas por el mismo endpoint que las demás plataformas. Cada métrica tiene un identificador (reference_key) que va en la llamada.

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"
      ]
    }
  ]
}
Ejemplo: "Total de pedidos" en octubre, comparado con septiembre.

Más ejemplos de llamadas a Olist

El mismo endpoint para cada tipo de métrica. Los campos metrics y dimensions de cada ítem vienen del catálogo de la plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Pedidos a lo largo del tiempo

Evolución diaria de los pedidos. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto.

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"
      ]
    }
  ]
}

Tabla

Pedidos por situación

Distribución de pedidos y valor de ventas agrupados por situación del pedido. Muestra todas las situaciones, incluyendo abiertas, canceladas y con datos 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

Ventas Totales

Suma de los totales de los pedidos en el período seleccionado. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto, siguiendo el estándar del dashboard de 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 en el período seleccionado. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto, siguiendo el estándar del dashboard de Olist.

    olist:total_orders
  • Ventas Totales

    Suma de los totales de los pedidos en el período seleccionado. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto, siguiendo el estándar del dashboard de Olist.

    olist:total_sales
  • Boleto promedio

    Valor medio de ventas por pedido en el período seleccionado. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto.

    olist:average_ticket
  • Pedidos cancelados

    Número total de pedidos cancelados en el período seleccionado.

    olist:canceled_orders

Gráficos

2 métricas

  • Pedidos a lo largo del tiempo

    Evolución diaria de los pedidos. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto.

    olist:orders_over_time
  • Ventas a lo largo del tiempo

    Evolución diaria del valor total de ventas. Excluye pedidos abiertos, cancelados y con datos incompletos por defecto.

    olist:sales_over_time

Tablas

1 métrica

  • Pedidos por situación

    Distribución de pedidos y valor de ventas agrupados por situación del pedido. Muestra todas las situaciones, incluyendo abiertas, canceladas y con datos incompletos.

    olist:orders_by_status

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.