DocsAPI ReferenceProduct/bff/product/analytics
getProductAdmin BFF

/bff/product/analytics

One-shot analytics payload for the product detail "Analytika" tab. Revenue uses real_money_price on non-storno order-items (identical to the branch Finance grid). Monthly buckets are keyed on COALESCE(calendar_event.start_time, order_item.inserted_date) so calendar-linked items land in the month they HAPPENED, not the month they were paid.

ProductgetBffProductAnalytics

Parameters

2 query

2 total
Query · 2
productCodestringRequired

Unique product code.

monthCountstring

Rolling window in months for the time-series (default 24, clamped to [1, 60]). KPIs and top-N lists are always LIFETIME regardless of this window.

Request

GET /bff/product/analytics

get
curl -X GET "https://api.bizkithub.com/bff/product/analytics?productCode=example_productCode&monthCount=example_monthCount" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key