Metrics

Olist metrics via API

Your customer connects their Olist account and your product queries 7 metrics through the same endpoint as every other platform. Each metric has an id (reference_key) that goes in the request.

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"
      ]
    }
  ]
}
Example: "Total orders" in October, compared to September.

More Olist request examples

The same endpoint for every kind of metric. The metrics and dimensions of each item come from the platform catalog (GET /api/metrics/{integration_slug}).

Chart

Orders over time

Daily evolution of orders. Excludes open, canceled, and incomplete orders by default.

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

Table

Orders by status

Breakdown of orders and sales value grouped by order status. Shows all statuses including open, canceled, and incomplete.

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

Number

Total sales

Sum of order totals for the selected period. Excludes open, canceled, and incomplete orders by default, following the Olist dashboard standard.

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

Numbers

4 metrics

  • Total orders

    Total number of orders in the selected period. Excludes open, canceled, and incomplete orders by default, following the Olist dashboard standard.

    olist:total_orders
  • Total sales

    Sum of order totals for the selected period. Excludes open, canceled, and incomplete orders by default, following the Olist dashboard standard.

    olist:total_sales
  • Average ticket

    Average sales value per order in the selected period. Excludes open, canceled, and incomplete orders by default.

    olist:average_ticket
  • Canceled orders

    Total number of canceled orders in the selected period.

    olist:canceled_orders

Charts

2 metrics

  • Orders over time

    Daily evolution of orders. Excludes open, canceled, and incomplete orders by default.

    olist:orders_over_time
  • Sales over time

    Daily evolution of total sales value. Excludes open, canceled, and incomplete orders by default.

    olist:sales_over_time

Tables

1 metric

  • Orders by status

    Breakdown of orders and sales value grouped by order status. Shows all statuses including open, canceled, and incomplete.

    olist:orders_by_status

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.