Guide: How to configure a campaign

General settings

Security

Configure the campaign security settings to protect your campaign from fraud and abuse.

We provide a complete set of default tools to protect your campaign:

• Blockchain storage of all user events and conversions
• Smart Contracts for agreements and payments
• S2S Postback tracking
• IP and User-Agent filtering

But you can also enable additional tools to further protect your campaign:

1. Private Keys: Check your private keys to authenticate your API requests.

   • Client ID: Your unique identifier for API requests.
   • Client Secret: Your secret key to authorize API requests.
   You’ll need them to track conversions from your side in a secure way. Check the Integration section to learn more about it.

2. Anti-bot: Tune your campaign to protect it from bots.

   • CAPTCHA Shield: Enable CAPTCHA verification to protect your campaign from spam and abuse.

     

   CAPTCHA challenges are shown to users clicking on a referral link. When a user or referrer is detected as suspicious, a CAPTCHA challenge appears before redirecting to your final destination URL.

   This is required for creating tracking events and conversions in the blockchain. This means that it’s not possible to impact your campaign budget without passing this proof of human interaction.

   

   I usually recommend enabling CAPTCHA verification, as the user experience is not significantly impacted for legitimate users, your campaign will be protected from fraud and abuse, and it generates a better sense of security for end users.

Integration

This section explains how to integrate BreadCrumbs tracking with your website or application. Integration is necessary when you want to track conversions beyond simple link clicks.

When is Integration Required?

• Click Through campaigns (automatic): No integration needed! Conversions are automatically tracked when users click affiliate links and are redirected to your destination URL.

• All other conversion types (requires integration): For conversion types like URL Visit, Sign Up, Wallet Connection, etc., you’ll need to implement code on your website to confirm when a user completes the desired action.

Integration Process Overview

1. How it works:

   • When users click on affiliate links, they’ll be redirected to your website with a tracking identifier (crumbId) in the URL
   • Your front-end code needs to extract this crumbId from the URL parameters
   • Your back-end server must send this crumbId back to BreadCrumbs when a conversion happens
   • This confirms the conversion and triggers the reward distribution

2. Integration Approach:

   • The BreadCrumbs tracking service requires server side integration for security reasons
   • Client side code only retrieves the crumbId from the URL
   • Server side code securely sends the conversion data to BreadCrumbs API

3. Technical Requirements:

   • Access to modify both your client side and server side code (or involve your development team)
   • API credentials from the Security page
   • Basic understanding of HTTP requests

Setting Up Integration

1. Get your API credentials from the Security page of your campaign:

   • Client ID
   • Client Secret
   Keep your Client Secret secure! These credentials must be kept on your server and never exposed client side.

2. Share integration instructions with your development team:

   • Direct developers to the Developer Documentation for detailed implementation guides
   • Consider sharing our integration demo and GitHub repository for reference implementation

3. Testing your integration:

   • Use the Preview page to test your integration setup
   • Verify conversions are properly tracked in your campaign analytics
   • Check if rewards are being distributed correctly

A successful integration requires two steps: (1) retrieving the crumbId from URL parameters on the client side, and (2) sending this crumbId to BreadCrumbs API from your server when the desired action is completed.

For technical details and implementation examples, please refer to our Developer Documentation.

Preview

Before publishing your campaign, it’s important to verify how it will appear to potential participants. The preview feature lets you see exactly what your campaign page will look like when live.

1. Access the preview: You can access the preview in two ways:

   • From the Customization tab, a “Preview” button appears in the right panel
   • From the left side menu, click on the “Preview” link

2. What you’ll see: The preview shows the complete public campaign page as participants will experience it, including:

   • Your campaign title, description, and image
   • Applied theme (light or dark) and brand color
   • Campaign details like reward amount and objectives
   • Participation instructions for referrers/affiliates
   • Link generation interface (non-functional in preview mode)
   The preview page has a notification badge indicating it’s not yet published. This banner won’t appear on the actual published campaign.

3. Review checklist:

   • Is your branding (colors, theme) properly represented?
   • Does your title clearly communicate the campaign purpose?
   • Is your description informative and compelling?
   • Does the image effectively represent your campaign?
   • Are the reward amounts and participation details correct?

Customization fields (title, description, image, theme and color) can be modified at any time even after publishing the campaign. But rest of the parameters that manage the logic of the campaign are locked once the campaign is published on the blockchain.

Pricing

In this section you can configure the financial aspects of your campaign, including pricing model, budget, and reward structure.

Before starting, you need know about the different plans BreadCrumbs offers.

There are three main plans, each designed for different project needs.

• Trial Plan: Perfect for testing the waters or small campaigns (Limited to 1 campaign and max 1000 POL budget).

• Native Token Plan: Tailored for small to medium Web3 projects.

  This plan uses native cryptocurrency (currently POL on Polygon network) for rewards, making it accessible and easy to fund.

• Custom Token Plan: Best for established projects with their own token and community.

  Custom Token Plan is currently in development. Contact our support team for more information.

You can better understand the plans and choose the best one for your campaign in our Pricing page.

2. Campaign Funding:

   1. Budget: Determine the total amount you want to allocate for your campaign rewards. This directly affects how many conversions your campaign can support.

   2. Reward Amount: Set the reward amount for each successful conversion. Participants (referrers/affiliates) will receive this amount for each qualified conversion they generate.

      Total conversions = Budget ÷ Reward Amount

   3. Discount Code: If you have a discount code, enter it to reduce the platform fee applied to your campaign.

3. Cost Summary:

   Review the summary section to see a breakdown of all costs associated with your campaign:

   Campaign funding:

   • Total objectives: The number of conversions your campaign budget can support
   • Campaign budget: Total amount allocated for rewards in your campaign

   Platform fee:

   • BreadCrumbs fee: Platform fee based on your selected plan (percentage varies by plan type)
   • Discount on BreadCrumbs fee: Any applied discounts from promotional codes (if applicable)

   Network gas fees:

   • Publish on-chain campaign: Estimated gas fee for creating your campaign on the blockchain
   • Tracking + Rewards: All transaction fees for tracking events and distributing rewards (Free - covered by BreadCrumbs)

   Total:

   • Campaign total (estimated): The complete amount you’ll need to fund your campaign

     When publishing your campaign, you’ll need to pay a small fee of native POL token to create it on-chain, as you’ll be the owner of the smart contract.

     You can modify your campaign’s pricing settings at any time before publishing. Once published, the budget and reward structure are locked in the blockchain.

   Now that you have configured all the sections, you are ready to publish your campaign.

   4. Click on the “Launch” button or the “Launch” link in the left panel to publish your campaign.

Launch

The final step is to launch your campaign, making it available for participants and starting the on-chain deployment process.

1. Campaign Schedule:

   • Start Date: Choose when your campaign should begin

     • Choose a specific future date to schedule your campaign launch

   • End Date: Decide when your campaign should finish

     • Leave blank for a permanent campaign that runs until budget is depleted
     • Set a specific end date to automatically terminate the campaign

2. Campaign Summary Review:

   Before publishing, thoroughly review all campaign details in the summary section. This comprehensive overview includes:

   Participants:

   • Campaign type: Whether your campaign is Referral, Affiliate, or both

   Rewards:

   • Total expected conversions: The number of conversions your budget can support
   • Reward per conversion: The amount each participant earns for a successful conversion
   • Network: The blockchain network your campaign runs on (currently Polygon)
   • Token: The cryptocurrency used for rewards

   Campaign pages:

   • Preview URL: Link to preview your campaign before publishing
   • Public URL: The link that will be active after publishing

   Security:

   • CAPTCHA Verification: Whether CAPTCHA protection is enabled

   Pricing:

   • Budget: Total amount allocated for campaign rewards
   • Platform fee: BreadCrumbs’ fee based on your selected plan
   • Total campaign cost: Complete amount needed to fund your campaign

   Schedule:

   • Start date: When your campaign will begin (immediately or scheduled)
   • End date: When your campaign will end (specific date or permanent)

   State:

   • Campaign status: Whether the campaign is active, upcoming, or finished
   • Balance: Remaining funds in your campaign
   • Completion percentage: Visual indicator of campaign progress

3. Publishing Process:

   • Click the “Publish” button to initiate the on-chain deployment
   • Your wallet will prompt you to sign a transaction for creating the campaign on the blockchain
   • This transaction requires a small amount of native token for gas fees
   • The system will display the deployment progress

4. What Happens After Publishing:

   • Your campaign is deployed as a smart contract on the blockchain
   • The campaign becomes visible to participants based on your type selection
   • Budget is locked in the smart contract and can only be used for rewards or returned to you if you cancel the campaign (remaining budget will be returned to your wallet)
   • Some campaign settings cannot be modified after publishing (conversion type, rewards, participants, …)
   You can cancel the campaign at any time, which will return unused funds to your wallet

After publishing, you’ll be able to both access the public campaign page and track your campaign’s performance in real-time through the analytics dashboard.

Published

Once your campaign is published, it’s live and ready for participants. The published page is the public-facing interface that your referrers and affiliates will use to create tracking links and monitor their performance.

1. Accessing the Published Page

• The published campaign is available on the left side menu as “Published” link
• This URL follows the format: https://bread-crumbs.tech/affiliates/campaigns/[campaign-slug]

2. Sharing Your Campaign Based on your campaign type, you should share your published campaign link differently:

• Referral Campaigns:

  • Share directly with your existing users and community members
  • Post in your Discord, Telegram, or other community platforms
  • Include in newsletters to your users
  • Share with your most active fans and supporters

• Affiliate Campaigns:

  • Share with your marketing partners and potential affiliates
  • Post on your social media channels to attract promoters
  • BreadCrumbs will also feature your campaign in our Meeting Point and share it with our community of marketers and content creators

3. On the published campaign page, participants can:

• Learn about your campaign details and rewards
• Generate unique tracking links to share with their audience
• Monitor their performance statistics
• Track their rewards earned
• Claim their earnings directly to their wallet

Now its time to monitor your campaign’s analytics regularly after publishing to track performance and make data-driven decisions for future campaigns.

Analytics

The Analytics dashboard provides comprehensive insights into your campaign’s performance, organized into four key sections.

1. Overview

Get a quick snapshot of your campaign’s performance through these essential KPIs:

• Total Events: Number of tracking events (clicks) generated by your campaign
• Conversions: Total number of successful conversions completed
• Conversion Rate: Percentage of events that resulted in conversions
• Avg. Time to Conversion: Average time between click and conversion
• Total Costs: Sum of all rewards paid out for conversions
• Top Performing Affiliate: The participant driving the most conversions

2. Affiliates

Gain insights into your campaign participants’ performance:

• Performance: Visual representation of your top-performing promoters

  • Identify which affiliates are generating the most conversions
  • See distribution of rewards across participants
  • Focus your partnership efforts on your most valuable promoters

• Top Affiliates: Detailed breakdown of participant metrics

  • View wallet addresses and performance data
  • Track conversion counts per affiliate
  • Monitor rewards earned by each participant

3. Events

Track all campaign activity in detail:

• Performance: Visualize your campaign’s performance over time

  • Toggle between period and cumulative views
  • Switch between different time intervals (daily/hourly)
  • Track metrics like clicks, conversions, and rates

• Recent Activity: Chronological log of all campaign events

  • See timestamps and status for each event
  • Identify which affiliate generated each conversion
  • View on-chain verification details

4. Costs

Monitor your campaign’s financial performance:

• Campaign Costs: Track your spending and budget utilization
  • Monitor budget spent on rewards and platform fees
    • Toggle between period and cumulative views
  • Switch between different time intervals (daily/hourly)
  • Analyze cost efficiency and ROI
  • Project campaign longevity based on current spending

All metrics update in real-time as new conversions occur, giving you accurate, up-to-date information to optimize your marketing strategy and measure campaign success.