Skip to main content

Dashboard

1 API call in this section.

Get Dashboard

Customer Portal / Delivery Management / Dashboard
GET/customer/delivery/dashboard?tz=UTC&recent_limit=5&chart_days=7

Returns dashboard data: KPIs, wallet snapshot, chart data, and recent deliveries. Metrics and chart series are aggregated server-side for lower latency.

Send a bearer token in the Authorization header for an authenticated OnDi user session.
Request
curl
1curl --request GET "$ONDI_BASE_URL/customer/delivery/dashboard?tz=UTC&recent_limit=5&chart_days=7" \2  --header "Authorization: Bearer {{access_token}}"

Query parameters

tzOptional
query string

UTC

IANA timezone

recent_limitOptional
query string

5

Number of recent deliveries (1-20)

chart_daysOptional
query string

7

Number of days for chart (7-31)

Headers

AuthorizationOptional
header string

Bearer {{access_token}}

Responses

Success200OK
Response body
json
1{2  "success": true,3  "data": {4    "metrics": {5      "created_mtd": 15,6      "in_transit": 3,7      "pending": 2,8      "delivered": 109    },10    "wallet": {11      "balance": 500,12      "spend_mtd": 15013    },14    "charts": {15      "delivery_week": {16        "title": "Orders This Week",17        "period": {18          "start": "2026-01-28",19          "end": "2026-02-04"20        },21        "data": {22          "labels": [23            "2026-01-28",24            "2026-01-29",25            "2026-01-30"26          ],27          "series": {28            "created": [29              2,30              3,31              132            ],33            "delivered": [34              1,35              2,36              137            ]38          }39        },40        "insights": {41          "total_created": 6,42          "total_delivered": 4,43          "completion_rate": 67,44          "trend": "up"45        }46      }47    },48    "recent_deliveries": [49      {50        "id": "uuid",51        "delivery_code": "DEL-12345",52        "from": "123 Main St",53        "to": "456 Oak Ave",54        "status": "in_transit",55        "payment_status": "paid",56        "delivery_fee": 25,57        "created_at": "2026-02-04T10:00:00Z"58      }59    ]60  }61}