Campaign Details API

The endpoint to retrieve campaign details is a unique URL provided by your AppSamurai account manager. The URL format is:

http://api.appsamurai.com/api/campaign-pull/list/YOUR_API_TOKEN

This URL remains valid unless you request a new one.

API Output

When you make a request to the API, the output will include all active campaigns available to you. The output format varies depending on the campaign type.

CPI Campaigns

{
  "campaign_id": 1235,
  "type": "non-incent",
  "app_title": "Climbing Pirates",
  "app_category": "Games / Casual",
  "app_store_url": "https://play.google.com/store/apps/details?id=com.sickkogames.pirates",
  "app_id": "com.sickkogames.pirates",
  "app_icon": "https:\/\/play-lh.googleusercontent.com\/Vt_eizbSd5GvaIwGUeL3XKaxIve682kwfWG6S5SJfsSBcQX0lQHjM6rz_mYVM8A8IAo=s180",
  "Start_date": "2025-02-19 12:25:00",
  "end_date": "No End Date",
  "daily_cap": 100,
  "daily_click_cap": 100000,
  "payout_type": "cpi",
  "revenue": 1.5,
  "campaign_name": "Climbing Pirates-iOS-AE",
  "tracking_url": "TRACKING URL",
  "country": "US",
  "countries": ["US", "TR"],
  "countries_with_cities": {
    "US": {
      "cities": ["New York", "Los Angeles"]
    },
    "TR": {
      "cities": ["Ankara", "Bursa"]
    }
  },
  "platform": "android",
  "creatives": {
    "images": [
      {
        "url": "CREATIVE URL",
        "width": null,
        "height": null
      },
      {
        "url": "CREATIVE URL",
        "width": null,
        "height": null
      }
    ],
    "videos": [],
    "others": []
  },
  "creative_zip": "CREATIVE ZIP URL",
  "devices": "Both",
  "required_fields": ["ref_id"],
  "blacklisted_subpublishers": [],
  "whitelisted_subpublishers": []
}

Multi-Rewarded CPE Campaigns

{
  "campaign_id": 120254,
  "type": "incent",
  "app_title": "Sling Plane 3D",
  "app_category": "Games / Simulation",
  "app_store_url": "https:\/\/play.google.com\/store\/apps\/details?id=com.panteon.slingplane\u0026referrer=utm_source%3D42matters.com%26utm_medium%3Dapi",
  "app_id": "com.panteon.slingplane",
  "app_icon": "https:\/\/play-lh.googleusercontent.com\/1ou1lb0lsImbDe_zB-MGOcfEpNecMEPBS6Qu-YrCFHxvsW8oWiTt37nmfkiAANofCg=s180",
  "start_date": "2023-02-07 10:56:00",
  "end_date": "No End Date",
  "daily_cap": 200,
  "daily_click_cap": 100000,
  "payout_type": "cpa",
  "cpa_event": "multi-event",
  "revenue": 1.9199999999999999,
  "campaign_name": "Sling Plane-120254-And_Phone-US-17Feb23-ADRP",
  "tracking_url": "https:\/\/click.appsamurai.com\/api\/callbacks\/click?sub_campaign_id=-QgfS_K1qCUvn5PP_vEmq-6E_kcvaJbe\u0026extra_1={userid}",
  "offer_name": "Reach Distance 1200, 4200, 8200 and 10200 m",
  "conversion_requirement": "Reach Distance 1200, 4200, 8200 and 10200 m",
  "country": "US",
  "countries": [
    "US"
  ],
  "countries_with_cities": {
    "US": {
      "cities": []
    }
  },
  "platform": "play",
  "devices": "Phone",
  "required_fields": [
    "ref_id"
  ],
  "event_goal": [
    {
      "event_name": "max_distance_reached_1000",
      "cpi_bid": "0.35",
      "event_token": "Reach distance 1200m"
    },
    {
      "event_name": "max_distance_reached_4000",
      "cpi_bid": "0.36",
      "event_token": "Reach distance 4200m"
    },
    {
      "event_name": "max_distance_reached_8000",
      "cpi_bid": "0.5",
      "event_token": "Reach distance 8200m"
    },
    {
      "event_name": "max_distance_reached_10000",
      "cpi_bid": "0.72",
      "event_token": "Reach distance 10200m"
    }
  ],
  "received_events": []
}

Parameter Definitions

campaign_id: AppSamurai's internal campaign ID.
type: Campaign type (incent or non-incent).
app_title: App's title on the app store.
app_category: App's store category and subcategory (if available).
app_store_url: App's URL on the App Store or Google Play.
app_id: Unique store ID.
end_date: Campaign end date.
daily_cap: Maximum number of conversions available to the partner.
cpi: Cost-per-install bid.
campaign_name: Campaign name in AppSamurai.
tracking_url: Campaign-specific tracking URL generated by AppSamurai.
country: First value of the "countries" parameter.
countries: Target countries for the campaign.
platform: Campaign's target platform (play or ios).
creative_zip: URL to download campaign creatives.
devices: Campaign's target device type (Phone, Tablet, or Both).
required_fields: Mandatory parameters to be passed on the tracking URL, always includes ref_id (unique click ID), and may include device_id (GAID or IDFA) if mandatory.
currency_multiplier: Currency multiplier for direct offerwalls.
event_name: Event tokens from AppSamurai servers.
event_token: Event definitions from AppSamurai servers.
conversion_requirement: Requirements for rewarded campaigns.
offer_name: Offer name for rewarded campaigns.

Important Notes

Fetch campaign details regularly (e.g., hourly) to stay updated on campaign status, payouts, and creatives.
If a campaign is no longer visible in the API, it has been disabled by the advertiser.
For multi-rewarded campaigns, you will receive events via postback as well.
Contact your account manager for additional support.