Program summary Coming soon

GET/v1/reports/program_summary

Returns totals for the date range and one row per local day.

Permissions: Secret key with reports:read.

Guide

Data sharing

Query parameters#

fromstring (date)Required
First local date, for example 2026-11-05.
tostring (date)Required
Last local date, included. Not before from.
location_idstring (uuid)
Only this location, in its time zone. Leave it out for the whole brand.

Response fields#

Returns 200 with ProgramSummaryReport

fromstring (date)
The range you asked for.
tostring (date)
The range you asked for.
location_idstring (uuid)Nullable
The location filter, or null for the whole brand.
time_zonestring
IANA time zone the days are counted in, for example America/Chicago.
currencystring
USD.
totalsReportFigures
The whole range, in the shape below.
Show attributesReportFigures
- membersobject
  Show attributesHide attributes
  - totalinteger
  - newinteger
  - activeinteger
- pointsobject
  Show attributesHide attributes
  - issuedinteger
  - redeemedinteger
  - adjustedinteger
  - outstandinginteger
- rewardsobject
  Show attributesHide attributes
  - issuedinteger
  - redeemedinteger
  - discount_centsinteger
- ordersobject
  Show attributesHide attributes
  - member_ordersinteger
  - member_sales_centsinteger
  - non_member_ordersinteger
  - non_member_sales_centsinteger
daysarray of object + ReportFigures
One object per local date, oldest first, each with date and the shape below.

Each of totals and the days entries holds:

Field	Description
`members.total`integer	Members enrolled at the end of the period, not counting deleted members. Brand-wide even with `location_id`.
`members.new`integer	Members enrolled during the period. With `location_id`, members whose first order was at that location.
`members.active`integer	Distinct members with at least one credited order in the period. In `totals` each member counts once, so it's usually less than the sum of the days.
`points.issued`integer	Points from `earn` and `bonus` activity.
`points.redeemed`integer	Points spent on rewards, as a positive number.
`points.adjusted`integer	Net of points adjustments and refund reversals. Usually negative.
`points.outstanding`integer	Sum of all members' balances at the end of the period. Brand-wide even with `location_id`.
`rewards.issued`integer	Wallet items issued.
`rewards.redeemed`integer	Redemptions captured by an order: points rewards, wallet items and codes used by members.
`rewards.discount_cents`integer	Sum of `discount_cents` on those redemptions.
`orders.member_orders`integer	Orders with a member, from every channel, including points earned at the register.
`orders.member_sales_cents`integer	Subtotal minus discounts on those orders. Tax and tip aren't included.
`orders.non_member_orders`integer	Orders unPLUG recorded with no member.
`orders.non_member_sales_cents`integer	Subtotal minus discounts on those orders.

Refunds count on the day they happen, not on the order's day, so a day's figures don't change after it ends.

Outstanding points move by issued minus redeemed plus adjusted: 2,104,380 + 55,210 - 28,000 - 90 = 2,131,500.

GET/v1/reports/program_summary

1
2curl "https://api.unplugdining.com/v1/reports/program_summary?from=2026-11-05&to=2026-11-06" \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/reports/program_summary?from=2026-11-05&to=2026-11-06", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    "https://api.unplugdining.com/v1/reports/program_summary?from=2026-11-05&to=2026-11-06",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29{
  "from": "2026-11-05",
  "to": "2026-11-06",
  "location_id": null,
  "time_zone": "America/Chicago",
  "currency": "USD",
  "totals": {
    "members": { "total": 8431, "new": 42, "active": 1020 },
    "points": { "issued": 114150, "redeemed": 58500, "adjusted": -210, "outstanding": 2131500 },
    "rewards": { "issued": 77, "redeemed": 148, "discount_cents": 50900 },
    "orders": { "member_orders": 1373, "member_sales_cents": 1336360, "non_member_orders": 2241, "non_member_sales_cents": 1981105 }
  },
  "days": [
    {
      "date": "2026-11-05",
      "members": { "total": 8412, "new": 23, "active": 611 },
      "points": { "issued": 58940, "redeemed": 30500, "adjusted": -120, "outstanding": 2104380 },
      "rewards": { "issued": 41, "redeemed": 77, "discount_cents": 26500 },
      "orders": { "member_orders": 702, "member_sales_cents": 683950, "non_member_orders": 1148, "non_member_sales_cents": 1012330 }
    },
    {
      "date": "2026-11-06",
      "members": { "total": 8431, "new": 19, "active": 588 },
      "points": { "issued": 55210, "redeemed": 28000, "adjusted": -90, "outstanding": 2131500 },
      "rewards": { "issued": 36, "redeemed": 71, "discount_cents": 24400 },
      "orders": { "member_orders": 671, "member_sales_cents": 652410, "non_member_orders": 1093, "non_member_sales_cents": 968775 }
    }
  ]
}

Error descriptions#

400Bad request

missing_param

from or to is missing.

400Bad request

invalid_param

A date isn't YYYY-MM-DD, or to is before from.

403Forbidden

missing_scope

The key doesn't have reports:read.

404Not found

location_not_found

No location with that id in your brand.

Any endpoint can also return the common errors.

400 Bad request

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#missing_param",
  "title": "Bad request",
  "status": 400,
  "code": "missing_param",
  "detail": "from or to is missing."
}