Campaign Management

Manage your campaigns once they’re live

Once your campaign is created, you will be able to see it in the Opportunities page. Note that it can take up to one hour to appear in our app due to cache.

Campaign Management Actions

You now have the full ownership of your campaign. You’ll be able to:

• Monitor its performance using our API (refer here for more details) or directly in the studio’s dashboard (coming soon)

• Track any delay related to the campaign or the chain on which the campaign is running using Merkl status page

• See the campaign leaderboard in the opportunity page to track addresses’ participation

• Integrate campaign data into your own app using our API. You’ll find the procedure here

• Reallocate unclaimed rewards from any recipient to another address at your discretion. You’ll find the procedure here

• Cancel a campaign: go in the studio using the creator address, select the campaign you want to cancel and click on the button on the right.

• (If needed) edit some parameters of your campaigns.

  ✅ You can:

  • Change the start date & end dates if they are not in the past

  • Edit blacklists or whitelists to include or exclude certain addresses

  • Enable additional features as needed

  ❌ You cannot:

  • Change the reward token

  • Change the total reward amount (create a new campaign for that — and shift the start/end date by at least 1 hour to avoid duplication bugs in the Merkl engine)

Note: If you want to add extra rewards or add another new reward token to your existing campaign, you’ll need to create another campaign on top of the current one. The new campaign must have a slightly modified start or end date (by a minimum of one hour) to prevent campaign duplication in our engine.

Merkl API Good to know

To fetch important data regarding your campaigns, you can use our API to get detailed information. More information here. Here are the most commonly used endpoints:

• Getting the leaderboard for your campaign: https://api.merkl.xyz/docs#tag/rewards/get/v4/rewards/

• Getting opportunities and their included campaigns: https://api.merkl.xyz/docs#tag/opportunities/get/v4/opportunities/campaigns

• Checking rewards amount at user level: https://api.merkl.xyz/docs#tag/users/GET/v4/users/%7Baddress%7D/rewards

• Checking rewards amount at campaign level: https://api.merkl.xyz/docs#tag/rewards/get/v4/rewards/total

• Checking rewards amount at token level: https://api.merkl.xyz/docs#tag/rewards/get/v4/rewards/token/

• Checking how many rewards are unclaimed: https://api.merkl.xyz/docs#tag/rewards/get/v4/rewards/unclaim/

• Integrating APRs data in your front-end: https://api.merkl.xyz/docs#tag/opportunities/get/v4/opportunities/

  • For this route, match the incentivized asset’s address with the “explorerAddress” field.

Note: You can find each campaign ID directly on the opportunities page here.