Insights

Retrieve aggregated analytics and operational insights for your organization, including order volume, fulfillment metrics, carrier performance, and cost analysis.

Get Insights

GET/api/insights

Retrieve analytics and operational insights.

Requiredinsights:read

Returns aggregated metrics based on the specified time range and optional filters. Use this to build dashboards, monitor KPIs, or generate reports.

Query Parameters

Parameter	Type	Description
`from`	string	Start of time range (ISO 8601, required)
`to`	string	End of time range (ISO 8601, required)
`granularity`	string	Data granularity: `hour`, `day`, `week`, `month` (default: `day`)
`metrics`	string	Comma-separated metrics to include (default: all)
`bridge_id`	string	Filter by bridge ID
`carrier`	string	Filter by carrier code

Available Metrics

Metric	Description
`order_volume`	Number of orders received
`fulfillment_rate`	Percentage of orders fulfilled
`average_fulfillment_time`	Average time from order to shipment
`shipping_cost`	Total shipping spend
`average_shipping_cost`	Average cost per shipment
`carrier_breakdown`	Order count by carrier
`status_breakdown`	Order count by status
`error_rate`	Percentage of failed operations


curl -X GET "https://api.orderly.dev/api/insights?from=2026-01-01T00:00:00Z&to=2026-01-15T23:59:59Z&granularity=day&metrics=order_volume,fulfillment_rate,shipping_cost" \
  -H "Authorization: Bearer ord_sk_..."

Response


{
  "data": {
    "period": {
      "from": "2026-01-01T00:00:00Z",
      "to": "2026-01-15T23:59:59Z"
    },
    "summary": {
      "order_volume": 1245,
      "fulfillment_rate": 0.94,
      "shipping_cost": 15678.50
    },
    "series": [
      {
        "date": "2026-01-01",
        "order_volume": 82,
        "fulfillment_rate": 0.96,
        "shipping_cost": 1023.40
      },
      {
        "date": "2026-01-02",
        "order_volume": 91,
        "fulfillment_rate": 0.93,
        "shipping_cost": 1142.10
      }
    ]
  }
}