Getnetworkoverview
curl --request GET \
--url https://api.loyalty.dog/v2/giftcards/network/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.loyalty.dog/v2/giftcards/network/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.loyalty.dog/v2/giftcards/network/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"totalMerchants": 123,
"totalCards": 123,
"totalTransactionVolume": "<string>",
"activeCards": 123,
"totalTransactions": 123,
"merchantBreakdowns": [
{
"merchantId": "5eb7cf5a86d9755df3a6c593",
"merchantName": "<string>",
"cardCount": 123,
"transactionVolume": "<string>"
}
],
"salesGrowth": "<string>",
"salesGrowthType": "<string>",
"merchantGrowth": "<string>",
"merchantGrowthType": "<string>",
"cardGrowth": "<string>",
"cardGrowthType": "<string>",
"txGrowth": "<string>",
"txGrowthType": "<string>",
"adoptionData": [
{
"label": "<string>",
"value": 123,
"secondaryValue": 123
}
],
"revenueData": [
{
"label": "<string>",
"value": 123
}
],
"breakage": {
"value": 123,
"total": 123,
"centerText": "<string>",
"label": "<string>"
},
"txFeeRevenue": "<string>",
"ltvUplift": "<string>",
"healthTxSuccessRate": 123,
"healthFraudAlerts": 123,
"healthSupportTickets": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Gift Cards
Getnetworkoverview
Network Overview
Returns aggregate statistics across the entire gift card network (all programs and merchants). Intended for network-admin and reporting dashboards.
Groups card counts and transaction volumes by merchant, and returns overall totals.
Status Codes:
- 200: Overview returned successfully
- 401: Unauthorized
- 403: Forbidden (caller is not a network admin)
GET
/
v2
/
giftcards
/
network
/
overview
Getnetworkoverview
curl --request GET \
--url https://api.loyalty.dog/v2/giftcards/network/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.loyalty.dog/v2/giftcards/network/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.loyalty.dog/v2/giftcards/network/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"totalMerchants": 123,
"totalCards": 123,
"totalTransactionVolume": "<string>",
"activeCards": 123,
"totalTransactions": 123,
"merchantBreakdowns": [
{
"merchantId": "5eb7cf5a86d9755df3a6c593",
"merchantName": "<string>",
"cardCount": 123,
"transactionVolume": "<string>"
}
],
"salesGrowth": "<string>",
"salesGrowthType": "<string>",
"merchantGrowth": "<string>",
"merchantGrowthType": "<string>",
"cardGrowth": "<string>",
"cardGrowthType": "<string>",
"txGrowth": "<string>",
"txGrowthType": "<string>",
"adoptionData": [
{
"label": "<string>",
"value": 123,
"secondaryValue": 123
}
],
"revenueData": [
{
"label": "<string>",
"value": 123
}
],
"breakage": {
"value": 123,
"total": 123,
"centerText": "<string>",
"label": "<string>"
},
"txFeeRevenue": "<string>",
"ltvUplift": "<string>",
"healthTxSuccessRate": 123,
"healthFraudAlerts": 123,
"healthSupportTickets": 123
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
JWT access token obtained from POST /v2/token.
Query Parameters
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Required string length:
24Pattern:
^[0-9a-f]{24}$Example:
"5eb7cf5a86d9755df3a6c593"
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
