v2
latestOpenAPI 3.1.02026-08-01244220427.0 KBGift Card Analytics
Get Analytics Overview
Return a KPI snapshot for the programme over the requested period.
Computes period-over-period deltas against the immediately preceding window of the same duration. Monetary values are returned as "0.00" strings to preserve decimal precision across JSON serialisation.
get/v2/giftcards/programs/{programId}/analytics/overview
Path parameters
programIdstring required
Example:5eb7cf5a86d9755df3a6c593
Query parameters
periodstring nullable
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/overview:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}