BizKitHub
DocsAPI ReferenceMember/bff/member/bff-usage
getMemberAdmin BFF

/bff/member/bff-usage

Returns the daily count of authenticated /bff/* requests this member has made over the last 90 days, sourced from cas__member_usage_daily (buffered in Redis, drained by flushMemberBffUsageToDb). Pending invitations always return an empty response. Powers the chart on the member Activity tab.

MembergetBffMemberBff-usage

Parameters

1 query

Query parameters

· 1
idstringRequired

Identifier of the member. For active members it is shop__contact.external_id; for pending invitations it is pending-<token>.

Exampleexample_id

Response schema

1 status code documented

200Success
isPendingbooleanRequired

True when the id refers to a pending invitation (no usage history exists).

usageListobject[]Required

Daily usage rows for the last 90 days, ordered by date ascending.

Each array item:
dateDate | string | string | numberRequired

Calendar day (organisation-local date).

One of 4:
Variant 1
Date

Calendar day (organisation-local date).

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
countnumberRequired

BFF requests attributed to the member on that day.

totalRequestsnumberRequired

Sum of count over the 90-day window.

todayCountnumberRequired

BFF requests attributed to the member today (up to the last flush).

avgDailynumberRequired

Average requests per observed day in the window.

peakCountnumberRequired

Highest single-day count in the window.

peakDateDate | string | string | number | nullRequired

Date of the peak day, or null when there is no usage.

One of 2:
Variant 1
Date | string | string | number
One of 4:
Variant 1
Date
Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
Variant 2
null
last7DaysTotalnumberRequired

Sum for the newest 7 days in the window.

previous7DaysTotalnumberRequired

Sum for the 7 days preceding the newest 7.

Response example

application/json
{
  "isPending": false,
  "usageList": [
    {
      "count": 0
    }
  ],
  "totalRequests": 0,
  "todayCount": 0,
  "avgDaily": 0,
  "peakCount": 0,
  "last7DaysTotal": 0,
  "previous7DaysTotal": 0
}

Request example

GET /bff/member/bff-usage

get
curl -X GET "https://api.bizkithub.com/bff/member/bff-usage?id=example_id" \
  -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