Skip to content

Get my statistics

Request

Returns the headline activity totals for the signed-in user - the sort of figures a volunteer portal shows on a dashboard, such as events attended, shifts worked, hours contributed and the current reward point balance. Each entry carries a stable code to key off, a display label already rendered in the account's own terminology, the value itself, and an icon hint the portal uses.

Which totals come back is a per-account choice, so the set of codes is not fixed and an account that has selected none receives an empty array. Treat code as the contract and ignore any code you do not recognise rather than relying on position. Totals are computed on read and briefly cached, so a figure can lag a change made moments earlier.

Security
default
Headers
Rosterfy-Platformstring
curl -i -X GET \
  https://developer.rosterfy.com/_mock/api-docs/openapi/api/v2/me/stats \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Rosterfy-Platform: admin'

Responses

Bodyapplication/json
Array [
codestring
labelstring
valueinteger
iconstring
]
Response
[ { "code": "reward_point_balance", "label": "Reward point balance", "value": 0, "icon": "fas fa-medal" }, { "code": "total_number_of_events", "label": "Total Number Of Events", "value": 4, "icon": "fas fa-star" }, { "code": "total_number_of_shifts", "label": "Total Number Of Shifts", "value": 4, "icon": "fas fa-calendar-alt" }, { "code": "total_shift_hours", "label": "Total Shift Hours Attended (By Scheduled Time)", "value": 18, "icon": "fas fa-clock" } ]