Merkl Developer Portal logo
get

/v4/ledger/campaigns/{campaignId}

Per-campaign ledger accounting (deposited / transferred / claimed / outstanding) with a page of reward entries

Path parameters

campaignIdstring
required

Campaign id (Hash(chainId-campaignId))

Query parameters

sortstring

<key>-<asc|desc>, one of: accrued, pending, claimed, recipient, reason, updatedAt. Amounts sort numerically, not as text. Above 10000 reward entries, only accrued sorts.

pagestring (integer) | integerdefault: 0

0-indexed page number. A page starts at row page * items, at most 10000.

itemsstring (integer) | integerdefault: 100

Number of items returned by page

Responses

200
Response for status 200
Schema
object
campaignIdstring
required
chainIdnumber
required
tokenstring
required
budgetstring
required
Base units, base-10
depositedstring
required
Base units, base-10
transferredstring
required
Base units, base-10
remainingstring
required
Base units, base-10
claimedstring
required
Base units, base-10
outstandingstring
required
Base units, base-10
pausedboolean
required
pauseReasonstring
required
startTsnumber
required
Unix seconds
endTsnumber
required
Unix seconds
registrationsnumber
required
updatedAtnumber
required
Unix millis
rewardTokenobject | null
required
The API's token record, or null for the native token and an unknown address
idstringUnique identifier for the token
namestring | nullFull name of the token
chainIdintegerChain Id
addressstring
decimalsnumberNumber of decimals for the token
symbolstringSymbol of the token
iconstringURL to the token icon image
verifiedbooleanWhether the token is verified
isNativebooleanWhether this is a native blockchain token
isTestbooleanWhether this is a test token
typeenumType of the token (TOKEN, PRETGE, POINT)TOKENPRETGEPOINT
pricenumber | nullCurrent price of the token in USD
updatedAtnumber | nullUnix timestamp of last price update
priceSourcestring | nullSource of the price information
displaySymbolstringCustom display symbol override
underlyingTokenIdstringIf this token is a wrapper, the ID of the underlying token
priceAlertDismissedAtnumber
priceAlertCountnumber
leavesnumber
required
Reward entries of the campaign
breakdownobject
required
totalnumber
required
Rows matching the filters
itemsobject[]
required
recipientstring
reasonstring
accruedstringBase units, base-10
pendingstringBase units, base-10
claimedstringBase units, base-10
Example
{
  "campaignId": "string",
  "chainId": 0,
  "token": "string",
  "budget": "string",
  "deposited": "string",
  "transferred": "string",
  "remaining": "string",
  "claimed": "string",
  "outstanding": "string",
  "paused": false,
  "pauseReason": "string",
  "startTs": 0,
  "endTs": 0,
  "registrations": 0,
  "updatedAt": 0,
  "rewardToken": {
    "id": "string",
    "name": "string",
    "chainId": 0,
    "address": "string",
    "decimals": 0,
    "symbol": "string",
    "icon": "string",
    "verified": false,
    "isNative": false,
    "isTest": false,
    "type": "TOKEN",
    "price": 0,
    "updatedAt": 0,
    "priceSource": "string",
    "displaySymbol": "string",
    "underlyingTokenId": "string",
    "priceAlertDismissedAt": 0,
    "priceAlertCount": 0
  },
  "leaves": 0,
  "breakdown": {
    "total": 0,
    "items": [
      {
        "recipient": "string",
        "reason": "string",
        "accrued": "string",
        "pending": "string",
        "claimed": "string"
      }
    ]
  }
}