Skip to main content
GET
/
api
/
v2
/
coupons
/
issued
/
stats
Issued-coupon stats
curl --request GET \
  --url https://api.zupy.com/api/v2/coupons/issued/stats/ \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "total_issued": 123,
    "used": 123,
    "usage_rate": 123,
    "by_status": {},
    "by_origin": {}
  },
  "meta": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.zupy.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Per-company partner API key (zupy_pk_…). Validated by Zupy against the company integration key hash (Story 14.x); send it on every request as the X-API-Key header. Scoped read-write to the owning company's data.

Query Parameters

​
customer_id
string

Restrict to one customer (LoyaltyUser id)

​
origin_type
enum<string>

Coupon provenance

Available options:
loyalty_reward,
marketing
​
reward_id
string

Per-reward stats: restrict to one reward

​
code
string

Exact coupon_code lookup (case-insensitive)

Response

​
data
object
​
meta
object