Get coupon analytics

GET

/v1/coupons/{code}/analytics

Get usage analytics for a coupon.

Parameters

Path Parameters

code

required

Code

string

Responses

200

Successful Response

CouponAnalyticsResponse

Analytics data for a coupon.

object

times_applied

required

Times Applied

integer

active_applications

required

Active Applications

integer

terminated_applications

required

Terminated Applications

integer

total_discount_cents

required

Total Discount Cents

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

remaining_uses

Any of:

integer

integer

null

null

401

Unauthorized

404

Coupon not found

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object