v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Gift Card Analytics

Get Analytics Trends

Return time-series transaction data bucketed by granularity.

The aggregation groups transactions by day in MongoDB, then Python re-buckets the daily totals into week/month windows. This avoids MongoDB version-specific $dateTrunc syntax.

get/v2/giftcards/programs/{programId}/analytics/trends

Path parameters

programIdstring required
Example:5eb7cf5a86d9755df3a6c593

Query parameters

periodstring nullable
granularitystring
fromstring nullable
tostring nullable
cardIdstring
Example:5eb7cf5a86d9755df3a6c593

Headers

X-Eposn-Customer-Tokenstring nullable
X-Eposn-Merchant-Tokenstring nullable

Response

Successful Response

{"stackTrail":"paths:/v2/giftcards/programs/{programId}/analytics/trends:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}