v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB

Gift Card Analytics

Export Analytics

Export analytics data for the period.

Generates the report synchronously, uploads to S3, and returns a pre-signed download URL (or a data: URI if S3 is unavailable).

post/v2/giftcards/programs/{programId}/analytics/export

Path parameters

programIdstring required

Example:5eb7cf5a86d9755df3a6c593

Query parameters

cardIdstring

Example:5eb7cf5a86d9755df3a6c593

Headers

X-Eposn-Customer-Tokenstring nullable

X-Eposn-Merchant-Tokenstring nullable

Request body

formatstring

periodstring nullable

fromstring nullable

tostring nullable

metricsstring[]

includePrivacyNoticeboolean

Response

Successful Response

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