Rewards report Coming soon

GET/v1/reports/rewards

Returns one row per reward that was issued or redeemed in the range, brand-wide, in your brand's default time zone. Rewards with no activity are left out.

Permissions: Secret key with reports:read.

Guide

Data sharing

Query parameters#

fromstring (date)Required
First local date.
tostring (date)Required
Last local date, included.

Response fields#

Returns 200 with RewardsReport

fromstring (date)
As in the program summary.
tostring (date)
As in the program summary.
time_zonestring
As in the program summary.
currencystring
As in the program summary.
dataarray of RewardReportRow
Show attributesRewardReportRow
- reward_idstring (uuid)
  The reward.
- namestring
  Its name today.
- kindstring
  points (bought with points at checkout) or wallet (issued to the wallet).
  One of points, wallet
- points_costintegerNullable
  For points rewards. Null for wallet rewards.
- issuedinteger
  Wallet items issued. Always 0 for points rewards, which never enter the wallet.
- redeemedinteger
  Redemptions captured by an order.
- points_spentinteger
  Points spent on it. 0 for wallet rewards.
- discount_centsinteger
  Discount given through it.

Codes aren't rewards, so redemptions of a promo code such as WELCOME10 appear in the program summary's rewards figures but not here. That's why this report adds up to 144 redemptions and the summary to 148.

GET/v1/reports/rewards

1
2curl "https://api.unplugdining.com/v1/reports/rewards?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/rewards?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/rewards?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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48{
  "from": "2026-11-05",
  "to": "2026-11-06",
  "time_zone": "America/Chicago",
  "currency": "USD",
  "data": [
    {
      "reward_id": "9a6e3d21-4c7b-4f8a-b2e5-0d1c6f3a7b98",
      "name": "Free drip coffee",
      "kind": "points",
      "points_cost": 500,
      "issued": 0,
      "redeemed": 70,
      "points_spent": 35000,
      "discount_cents": 22750
    },
    {
      "reward_id": "5e8b1f4c-2d9a-4b6e-8c3f-7a0d2e9b1c65",
      "name": "Free pastry",
      "kind": "points",
      "points_cost": 700,
      "issued": 0,
      "redeemed": 22,
      "points_spent": 15400,
      "discount_cents": 7900
    },
    {
      "reward_id": "b3d7a9e2-6f1c-4a8d-9e5b-2c4f7a1d3e86",
      "name": "$5 off",
      "kind": "points",
      "points_cost": 900,
      "issued": 0,
      "redeemed": 9,
      "points_spent": 8100,
      "discount_cents": 4500
    },
    {
      "reward_id": "d4c2e8a6-7b3f-4e1d-9a5c-1f8b6d3e0a92",
      "name": "Fall pastry on us",
      "kind": "wallet",
      "points_cost": null,
      "issued": 77,
      "redeemed": 43,
      "points_spent": 0,
      "discount_cents": 15250
    }
  ]
}

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.

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."
}