All Offers API

Overview

The Offers API provides publishers with access to available advertising campaigns (offers) tailored to their account status, target device, and promotion methods. Each offer includes comprehensive details about payouts, requirements, targeting restrictions, and multi-tier reward structures.

Quick Start

Get your first offers in 30 seconds:

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4"

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4"

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4"

Authentication

All requests require your API key. Include it in the key parameter of every request.

To find your API Key, log into your Publisher Account, go to My Account -> API Key

Base URL

https://publishers.revenueuniverse.com/affiliates/api.php

Request Parameters

Response Format

Success Response

{
  "status": "success",
  "affiliate_id": 1234,
  "wall_id": 123,
  "offers": [
    {
      "cid": 46713,
      "name": "TikTok - Install and Watch 1 Videos",
      "headline": "Install & Watch 1 Video on TikTok!",
      "description": "TikTok is THE destination for mobile videos...",
      "requirements": "Install TikTok app and watch at least 1 videos to get rewarded!",
      "extra_terms": "You must hit \"Allow\" when the app asks to track...",
      "category": "Mobile Apps",
      "reporting": "Hourly",
      "rate": 2,
      "currency": 200,
      "offer_type": 8,
      "url": "https://publishers.revenueuniverse.com/click.php?affiliate=1234&campaign=12345...",
      "platform": "iOS",
      "countries": ["US"],
      "cap": {
        "type": "Daily (GMT)",
        "position": "0",
        "maximum": "100"
      },
      "conversion_rate": 0.2,
      "epc": 0.06
    }
  ]
}

{
  "status": "success",
  "affiliate_id": 1234,
  "wall_id": 123,
  "offers": [
    {
      "cid": 46713,
      "name": "TikTok - Install and Watch 1 Videos",
      "headline": "Install & Watch 1 Video on TikTok!",
      "description": "TikTok is THE destination for mobile videos...",
      "requirements": "Install TikTok app and watch at least 1 videos to get rewarded!",
      "extra_terms": "You must hit \"Allow\" when the app asks to track...",
      "category": "Mobile Apps",
      "reporting": "Hourly",
      "rate": 2,
      "currency": 200,
      "offer_type": 8,
      "url": "https://publishers.revenueuniverse.com/click.php?affiliate=1234&campaign=12345...",
      "platform": "iOS",
      "countries": ["US"],
      "cap": {
        "type": "Daily (GMT)",
        "position": "0",
        "maximum": "100"
      },
      "conversion_rate": 0.2,
      "epc": 0.06
    }
  ]
}

{
  "status": "success",
  "affiliate_id": 1234,
  "wall_id": 123,
  "offers": [
    {
      "cid": 46713,
      "name": "TikTok - Install and Watch 1 Videos",
      "headline": "Install & Watch 1 Video on TikTok!",
      "description": "TikTok is THE destination for mobile videos...",
      "requirements": "Install TikTok app and watch at least 1 videos to get rewarded!",
      "extra_terms": "You must hit \"Allow\" when the app asks to track...",
      "category": "Mobile Apps",
      "reporting": "Hourly",
      "rate": 2,
      "currency": 200,
      "offer_type": 8,
      "url": "https://publishers.revenueuniverse.com/click.php?affiliate=1234&campaign=12345...",
      "platform": "iOS",
      "countries": ["US"],
      "cap": {
        "type": "Daily (GMT)",
        "position": "0",
        "maximum": "100"
      },
      "conversion_rate": 0.2,
      "epc": 0.06
    }
  ]
}

Error Response

{
  "error": "No eligible promo types found. You may need to specify an offer wall."
}

{
  "error": "No eligible promo types found. You may need to specify an offer wall."
}

{
  "error": "No eligible promo types found. You may need to specify an offer wall."
}

Offer Object Reference

Basic Properties

Offer Type Mapping

Financial & Performance Information

Targeting & Restrictions

Capping & Reporting Time

Image Assets

URLs

Multi-Reward Offers (Tiers)

Versions 2 and above support offers with multiple reward tiers. These appear when tiers: true:

{
  "cid": 48323,
  "name": "Vegas Casino & Slots - Multi - 30 days",
  "tiers": true,
  "tiers_list": [
    {
      "requirements": "Install the app",
      "currency": 20,
      "rate": 0.01,
      "sid4": ""
    },
    {
      "requirements": "Complete Level 6",
      "currency": 20,
      "rate": 0.01,
      "sid4": "5levelup_slots"
    },
    {
      "requirements": "Complete Level 11",
      "currency": 220,
      "rate": 0.11,
      "sid4": "10levelup_slots"
    }
  ],
  "currency_with_tiers": 125240
}

{
  "cid": 48323,
  "name": "Vegas Casino & Slots - Multi - 30 days",
  "tiers": true,
  "tiers_list": [
    {
      "requirements": "Install the app",
      "currency": 20,
      "rate": 0.01,
      "sid4": ""
    },
    {
      "requirements": "Complete Level 6",
      "currency": 20,
      "rate": 0.01,
      "sid4": "5levelup_slots"
    },
    {
      "requirements": "Complete Level 11",
      "currency": 220,
      "rate": 0.11,
      "sid4": "10levelup_slots"
    }
  ],
  "currency_with_tiers": 125240
}

{
  "cid": 48323,
  "name": "Vegas Casino & Slots - Multi - 30 days",
  "tiers": true,
  "tiers_list": [
    {
      "requirements": "Install the app",
      "currency": 20,
      "rate": 0.01,
      "sid4": ""
    },
    {
      "requirements": "Complete Level 6",
      "currency": 20,
      "rate": 0.01,
      "sid4": "5levelup_slots"
    },
    {
      "requirements": "Complete Level 11",
      "currency": 220,
      "rate": 0.11,
      "sid4": "10levelup_slots"
    }
  ],
  "currency_with_tiers": 125240
}

Tier Properties

Working with Multi-Reward Offers

• currency_with_tiers: Sum of all possible currency rewards

• sid4: Use this identifier in postback tracking by adding $sid4$ to your postback template

• Empty sid4 values are valid and represent completion events

Multi-Reward Event Tracking

User progression through Multi-Reward campaigns can be tracked by (1) using postbacks from RevU or (2) by calling the User Level Offer API. 

Use Cases:

• Progress Visualization: Display completion indicators for partially completed multi-reward offers

• Offer Filtering: Hide completed tiers while maintaining visibility of available progression opportunities

• User Experience Optimization: Provide contextual information about user progress and remaining earning potential

Option 1: Implementing Tier-Specific Tracking with Postbacks

To enable precise tracking of multi-reward offer completions, incorporate the $sid4$ parameter into your postback URL template. This parameter will be dynamically populated with the tier-specific event identifier that corresponds to the sid4 value returned in the Offers API response.

Postback Template Example:

https://your-domain.com/postback?user_id=$uid$&campaign_id=$campaign$&tier=$sid4$&payout=$rate$

Event Identifier Specifications

Direct Correlation: The $sid4$ placeholder receives the exact sid4 value from the API response, enabling accurate attribution of tier-specific conversions within multi-reward campaigns.

Empty Value Handling: The sid4 parameter may contain an empty string, which constitutes a valid event identifier. Your postback processing logic must recognize empty sid4 values as legitimate tier completion events, not as data omissions or system errors.

Uniqueness Constraints: The sid4 value maintains uniqueness only within the scope of its associated campaign. To ensure system-wide uniqueness, combine the sid4 value with the $campaign$ identifier in your tracking implementation to prevent identifier conflicts across different campaigns.

Single-Reward Offer Considerations

Standard offers with tiers: false do not include sid4 values in their API response structure. However, when the $sid4$ placeholder is present in your postback template, the system may still populate this parameter for single-reward offers. In such scenarios:

• Disregard the sid4 value for offers where tiers: false

• Interpret any postback as confirmation of complete offer fulfillment

• Remove the completed offer from the user's available offer inventory

Option 2: User Level Offer API to Check Progression

The User Level Offer API provides comprehensive tracking capabilities for monitoring user progress across individual tiers within multi-reward offers. Implement API calls that include the user identifier (UID) to retrieve current completion status for all campaign tiers.

Implementation Process

1. API Call: Execute a request to the User Level Offer API with the required UID parameter, append User-IP and Device if called server-side

2. Response Processing: Locate the campaign-specific tiers_url endpoint within the API response

3. Status Retrieval: Query the tiers_url to obtain real-time completion status for each available tier

The tiers_url endpoint delivers current progress data, enabling dynamic user interface updates and accurate offer presentation based on individual user advancement within multi-reward campaigns.

Additional Information & Usage Recommendations

Common Error Codes

Example Requests

Get All Offers

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&key=YOUR_API_KEY&action=offers&version=4

Get Specific Offer

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&offer=OFFER_ID&key=YOUR_API_KEY&action=offers&version=4"

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&offer=OFFER_ID&key=YOUR_API_KEY&action=offers&version=4"

curl "https://publishers.revenueuniverse.com/affiliates/api.php?wall=YOUR_WALL_ID&offer=OFFER_ID&key=YOUR_API_KEY&action=offers&version=4"

Filter by Platform

// After receiving the API response
const iosOffers = offers.filter(offer => 
  offer.platform === 'iOS' || offer.platform === 'All'
);
const androidOffers = offers.filter(offer => 
  offer.platform === 'Android' || offer.platform === 'All'
);

// After receiving the API response
const iosOffers = offers.filter(offer => 
  offer.platform === 'iOS' || offer.platform === 'All'
);
const androidOffers = offers.filter(offer => 
  offer.platform === 'Android' || offer.platform === 'All'
);

// After receiving the API response
const iosOffers = offers.filter(offer => 
  offer.platform === 'iOS' || offer.platform === 'All'
);
const androidOffers = offers.filter(offer => 
  offer.platform === 'Android' || offer.platform === 'All'
);

Integration Tips

Click URL Modification

The url field contains a template that needs modification before serving to users - append the userId after sid2= without modifying the rest of the URL:

// Example: Replace tracking parameters
let clickUrl = offer.url;
clickUrl = clickUrl.replace('&sid2=', '&sid2=USER_ID_HERE');

// Example: Replace tracking parameters
let clickUrl = offer.url;
clickUrl = clickUrl.replace('&sid2=', '&sid2=USER_ID_HERE');

// Example: Replace tracking parameters
let clickUrl = offer.url;
clickUrl = clickUrl.replace('&sid2=', '&sid2=USER_ID_HERE');

Cap Management

Check the cap object to avoid showing exhausted offers:

const availableOffers = offers.filter(offer => {
  if (!offer.cap) return true; // No cap restrictions
  
  const position = parseInt(offer.cap.position);
  const maximum = parseInt(offer.cap.maximum);
  
  return position < maximum;
});

const availableOffers = offers.filter(offer => {
  if (!offer.cap) return true; // No cap restrictions
  
  const position = parseInt(offer.cap.position);
  const maximum = parseInt(offer.cap.maximum);
  
  return position < maximum;
});

const availableOffers = offers.filter(offer => {
  if (!offer.cap) return true; // No cap restrictions
  
  const position = parseInt(offer.cap.position);
  const maximum = parseInt(offer.cap.maximum);
  
  return position < maximum;
});

Multi-Reward Tracking

For offers with tiers: true, implement progress tracking:

if (offer.tiers) {
  // Show tier progression UI
  offer.tiers_list.forEach(tier => {
    console.log(`Tier: ${tier.requirements} → ${tier.currency} coins`);
  });
  
  // Total possible reward
  console.log(`Max reward: ${offer.currency_with_tiers} coins`);
}

if (offer.tiers) {
  // Show tier progression UI
  offer.tiers_list.forEach(tier => {
    console.log(`Tier: ${tier.requirements} → ${tier.currency} coins`);
  });
  
  // Total possible reward
  console.log(`Max reward: ${offer.currency_with_tiers} coins`);
}

if (offer.tiers) {
  // Show tier progression UI
  offer.tiers_list.forEach(tier => {
    console.log(`Tier: ${tier.requirements} → ${tier.currency} coins`);
  });
  
  // Total possible reward
  console.log(`Max reward: ${offer.currency_with_tiers} coins`);
}

Rate Limiting

• API calls are monitored for abuse

• Recommended: Cache responses for 2-10 minutes

• Excessive requests (>5 per minute) may result in temporary blocking

Support

For technical support or questions about specific offers, reach out to your account manager or sales contact.