BizKitHub
DocsAPI ReferenceAnalytics/bff/analytics/detail
getAnalyticsAdmin BFF

/bff/analytics/detail

Runs a specific analytics report. Supports per-report query params, pagination, sorting and free-text search. Permission is checked per report.

AnalyticsgetBffAnalyticsDetail

Parameters

7 query

Query parameters

· 7
slugstringRequired

Report slug.

Examplesales-daily-revenue
localestringOptional
Examplecs
pagestring | numberOptional
Range: 1–∞Default: 1
Example1
pageSizestring | numberOptional
Range: 1–500Default: 50
Example50
sortBystringOptional
Exampleexample_sortBy
sortDir"asc" | "desc"Optional
searchstringOptional
Exampleexample_search

Response schema

1 status code documented

200Success
slugstringRequired
headerLabelsobjectRequired
rowsany[]Required
columnsany[]Optional
kpisany[]Optional
chartanyOptional
paginationobjectRequired
pagenumberRequired
pageSizenumberRequired
totalnumberRequired
metaobjectRequired
generatedAtstringRequired
cachedbooleanOptional
truncatedbooleanOptional

Response example

application/json
{
  "slug": "example_slug",
  "headerLabels": {},
  "rows": [],
  "columns": [],
  "kpis": [],
  "pagination": {
    "page": 0,
    "pageSize": 0,
    "total": 0
  },
  "meta": {
    "generatedAt": "example_generatedAt",
    "cached": false,
    "truncated": false
  }
}

Request example

GET /bff/analytics/detail

get
curl -X GET "https://api.bizkithub.com/bff/analytics/detail?slug=sales-daily-revenue&locale=cs&page=1&pageSize=50&sortBy=example_sortBy&search=example_search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key