Management API
Reports
Read your program's daily totals as JSON: members, points, rewards and member sales. Use them for a dashboard tile or a weekly email without loading the full data export.
Coming soon
Coming soon The Reports API isn't released yet. The shapes below are what we plan to ship. For row-level data, see Data sharing.
Both endpoints need a secret key with the reports:read scope. Ask support to add it to a key.
Dates and time zones#
from and to are local dates (YYYY-MM-DD), and both are included. A day runs midnight to midnight in the location's time zone when you pass location_id, and in your brand's default time zone otherwise. The response says which time zone it used. Times inside the data, such as when a reward was redeemed, are counted on the local date they fall on.
Today's figures are partial until the day ends. Money is in integer cents with currency.