curl --request GET \
--url https://api-next.ofauth.com/v2/access/analytics/promotions/top \
--header 'apiKey: <api-key>' \
--header 'x-connection-id: <api-key>'{
"hasMore": true,
"items": [
{
"id": 123,
"message": "<string>",
"rawMessage": "<string>",
"hasRelatedPromo": true,
"price": 123,
"type": "<string>",
"canClaim": true,
"claimsCount": 123,
"subscribeCounts": 123,
"subscribeDays": 123,
"createdAt": "<string>",
"finishedAt": "<string>",
"isFinished": true
}
]
}Get top performing promotions
Permission Required: analytics:read
curl --request GET \
--url https://api-next.ofauth.com/v2/access/analytics/promotions/top \
--header 'apiKey: <api-key>' \
--header 'x-connection-id: <api-key>'{
"hasMore": true,
"items": [
{
"id": 123,
"message": "<string>",
"rawMessage": "<string>",
"hasRelatedPromo": true,
"price": 123,
"type": "<string>",
"canClaim": true,
"claimsCount": 123,
"subscribeCounts": 123,
"subscribeDays": 123,
"createdAt": "<string>",
"finishedAt": "<string>",
"isFinished": true
}
]
}Requires a connection via the x-connection-id header.
Number of items to return (1-100, default: 20)
1 <= x <= 100Number of items to skip (default: 0)
x >= 0Start of date range (ISO 8601)
End of date range (ISO 8601)
Was this page helpful?