RErewritelifestyle
Rewards (admin analytics)

Every prize earned in the range: who, what, why, status and who delivered it

Changed on

Paginated, newest first. limit goes up to 5000 for the CSV export. date_field=delivered makes it the fulfilment report: delivered prizes by delivery day. fulfilled_by_id narrows to one staff member. Rows carry delivery_note, the note left when it was marked delivered.

get/api/rewards/admin/analytics/grants

Request

  • Base URL
    https://api.rewritelifestyle.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

fromstring

First local day, inclusive (YYYY-MM-DD). Defaults to the launch day.

tostring

Last local day, inclusive (YYYY-MM-DD). Defaults to today.

timezonestring

IANA zone the days are read in. Defaults to America/New_York.

launchFromstring

Rewards launch day (YYYY-MM-DD). Defaults to the day the first points were earned.

includeStaffboolean

Count coaches, PCs, admins and internal/tester accounts too.

status'pending' | 'claimed' | 'fulfilled' | 'delivered' | 'awaiting_delivery' | 'manual_review' | 'expired' | 'revoked'
reward_typestring

Prize type, e.g. log_review.

fulfilled_by'admin' | 'coach' | 'system' | 'auto' | 'none'
fulfilled_by_idnumber

Only prizes this staff member marked delivered (as admin or coach). Options: GET analytics/fulfillers.

date_field'earned' | 'delivered'

Which date from/to apply to. delivered lists only delivered prizes, by delivery day, newest first.

qstring

Search by user name or email.

pagenumber
limitnumber

Up to 5000, for the CSV export.

Changes