Skip to main content
GET
/
v2
/
access
/
analytics
/
promotions
/
top
Top promotions
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
    }
  ]
}

Authorizations

apiKey
string
header
required

Your OFAuth API key for authenticating requests.

x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Query Parameters

limit
integer
default:20

Number of items to return (1-100, default: 20)

Required range: 1 <= x <= 100
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0
startDate

Start of date range (ISO 8601)

endDate

End of date range (ISO 8601)

Response

Successful response

hasMore
boolean
required
items
object[]
required