BizKitHub
DocsAPI ReferenceAnalytics/bff/analytics/category-list
getAnalyticsAdmin BFF

/bff/analytics/category-list

Returns analytics categories with reports the caller has permission to read. Empty categories are pruned. Category and report copy honours the optional locale query param.

AnalyticsgetBffAnalyticsCategory-list

Parameters

1 query

Query parameters

· 1
localestringOptional

Locale for category/report copy.

Exampleen

Response schema

1 status code documented

200Success
itemsobject[]Required
Each array item:
idstringRequired

Category identifier.

titlestringRequired

Category title.

descriptionstringOptional
colorstringRequired

Tailwind text color class.

bgColorstringRequired

Tailwind background color class.

analyticsobject[]Required
Each array item:
slugstringRequired
namestringRequired
descriptionstringOptional
popularbooleanOptional

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "title": "example_title",
      "description": "example_description",
      "color": "example_color",
      "bgColor": "example_bgColor",
      "analytics": [
        {
          "slug": "example_slug",
          "name": "example_name",
          "description": "example_description",
          "popular": false
        }
      ]
    }
  ]
}

Request example

GET /bff/analytics/category-list

get
curl -X GET "https://api.bizkithub.com/bff/analytics/category-list?locale=en" \
  -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