Export Analytics
curl --request POST \
--url https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"format": "csv",
"period": "<string>",
"from": "<string>",
"to": "<string>",
"metrics": [
"<string>"
],
"includePrivacyNotice": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
format: 'csv',
period: '<string>',
from: '<string>',
to: '<string>',
metrics: ['<string>'],
includePrivacyNotice: false
})
};
fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export"
payload = {
"format": "csv",
"period": "<string>",
"from": "<string>",
"to": "<string>",
"metrics": ["<string>"],
"includePrivacyNotice": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}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
Export Analytics
curl --request POST \
--url https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"format": "csv",
"period": "<string>",
"from": "<string>",
"to": "<string>",
"metrics": [
"<string>"
],
"includePrivacyNotice": false
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
format: 'csv',
period: '<string>',
from: '<string>',
to: '<string>',
metrics: ['<string>'],
includePrivacyNotice: false
})
};
fetch('https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.loyalty.dog/v2/giftcards/programs/{programId}/analytics/export"
payload = {
"format": "csv",
"period": "<string>",
"from": "<string>",
"to": "<string>",
"metrics": ["<string>"],
"includePrivacyNotice": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
JWT access token obtained from POST /v2/token.
Path Parameters
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Query Parameters
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Body
application/json
Response
Successful Response
