Download Scheduled Report

Generate and stream the latest report data for a schedule.

Defaults to the last 30 days of transactions regardless of the schedule’s configured period. The response Content-Disposition header carries the suggested filename derived from the schedule name and current date.

GET /v2/giftcards/programs/{programId}/reports/scheduled/{scheduleId}/download

Download Scheduled Report

cURL

curl --request GET \
  --url https://api.loyalty.dog/v2/giftcards/programs/{programId}/reports/scheduled/{scheduleId}/download \
  --header 'Authorization: Bearer <token>'

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

JWT access token obtained from POST /v2/token.

Headers

X-Eposn-Customer-Token · string | null

X-Eposn-Merchant-Token · string | null

Path Parameters

programId · string | null · required

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

scheduleId · string · required

Query Parameters

cardId · string | null

Required string length: 24

Pattern: ^[0-9a-f]{24}$

Example:

"5eb7cf5a86d9755df3a6c593"

Response

200

application/json

Successful Response