Documentation Index
Fetch the complete documentation index at: https://docs.foodsave.kz/llms.txt
Use this file to discover all available pages before exploring further.
Analytics API
Base paths: /api/v1/admin/analytics and /api/v1/partners/me/analytics
Overview
Analytics endpoints are grouped for platform admins and partners. Most routes accept a period query parameter.
Analytics endpoints are read-heavy; if you use them in dashboards, debounce calls and cache results on the client.
Dashboard
Partner stats
Python
curl --request GET \
--url "https://api.foodsave.kz/api/v1/admin/analytics/dashboard?period=30d" \
-H 'Authorization: Bearer $ADMIN_TOKEN'
curl --request GET \
--url "https://api.foodsave.kz/api/v1/partners/me/analytics?period=30d" \
-H 'Authorization: Bearer $PARTNER_TOKEN'
import os
import requests
response = requests.get(
'https://api.foodsave.kz/api/v1/admin/analytics/dashboard?period=30d',
headers={'Authorization': f"Bearer {os.environ['ADMIN_TOKEN']}"}
)
print(response.json())
Common query parameters
period - 7d, 30d, 90d, 1y (default 30d)limit - max items to return for ranked listspartnerId - optional target partner for admin reports
GET /api/v1/admin/analytics/dashboard
Platform dashboard statistics.
{ "orders": 1234, "gmv": 905000, "activePartners": 98, "period":"30d" }
GET /api/v1/admin/analytics/partners/{id}
Partner statistics for an admin.
{ "partnerId":"p-1", "orders": 114, "gmv": 170000 }
GET /api/v1/partners/me/analytics
Partner self-serve statistics.
{ "partnerId":"p-1", "orders": 114, "gmv": 170000 }
GET /api/v1/admin/analytics/top-boxes
Top boxes by performance.
[{ "boxId":"b-1", "orders":42, "gmv":63000 }]
GET /api/v1/admin/analytics/top-partners
Rank partners by GMV or orders.
[{ "partnerId":"p-1", "orders": 500, "gmv": 700000 }]
GET /api/v1/admin/analytics/order-heatmap
[{ "hour": 12, "count": 24 }]
GET /api/v1/admin/analytics/listing-heatmap
[{ "hour": 18, "count": 11 }]
GET /api/v1/admin/analytics/peak-hours
[{ "hour": 19, "count": 122 }]