Skip to content

Admin: Campaigns Page Overview

How to Get There

  1. Log in to the AffiliatePro application admin.
  2. In the top bar, open the Marketing dropdown → click Campaigns.

The page title is Campaigns. This is the central place to create and manage all campaigns and their integration methods.

Creating a New Campaign

At the top of the Campaigns page you see four campaign type cards:

  • Banner Campaign — image/banner-based campaign
  • Text Campaign — text link or ad campaign
  • Link Campaign — standard link campaign
  • Video Campaign — video-based campaign

Click Create New on any card to open a blank campaign form of that type. The campaign type (Banner, Text, Link, Video) only determines the media format — you configure the integration method separately inside the form.

Campaigns Table

Below the type cards is a filterable table of all existing campaigns. Columns:

  • Image — campaign thumbnail. Click it to open Campaign Info.
  • Campaign Name — name, type badge, owner badge (Admin or vendor username), category badge, and creation date.
  • Integration Plugin Name — the integration plugin assigned to this campaign (if any).
  • View — total trigger/click count.
  • Ratio — conversion ratio breakdown (clicks vs. sales or action).
  • Integration Status — shows the integration method badge and a quick-access action button:
    • JS Pixel campaigns: a code button — click it to open the integration code modal directly (same code shown by View Integration Code in the form).
    • S2S API campaigns: a server button — opens the S2S setup modal.
    • Mobile / S2S Direct campaigns: a phone button — opens the Mobile setup modal.
    • Postback campaigns: an arrows button — opens the Postback setup modal.
    • Conversion API campaigns: a braces button — opens the Conversion API setup modal.

    These modals let you view the integration details without opening the full campaign form.

  • Campaign Status — Public / In Review / Draft, plus a schedule button showing the campaign period (start and end dates, or Lifetime).
  • Action — edit button + dropdown:
    • Edit (pencil button) — opens the full campaign form.
    • MLM Info — shows commission structure (only if MLM/multi-level is enabled for this campaign).
    • Campaign Info — opens a modal with tool type, commission structure, and transaction statistics.
    • Terms — view the campaign terms (for vendor campaigns).
    • Validate Campaign — runs a security/integrity check on this specific campaign and updates its Integration Status badge.
    • Duplicate — creates a copy of the campaign.
    • Delete — permanently deletes the campaign (confirmation required).

Filters

The filter panel (collapsible) lets you search and narrow the campaigns list by:

  • Category — filter by campaign category.
  • Campaign Name — live search by name.
  • Vendor — All Campaigns / Admin only / Vendors only / specific vendor.
  • Groups — filter by affiliate group access (multi-select).
  • Status — Public / In Review / Draft.
  • Show Only Admin toggle — hides vendor campaigns.

Click Clear Filters to reset all filters at once.

Utility Tools

Two utility buttons appear inside the filter bar:

  • Cron job setting — opens a modal explaining how to set up the cron job that runs the campaign security checker automatically (runs at * * * * * once per minute via the provided cURL command).
  • Perform Integration Check — opens a modal to run a full security/integrity check across all campaigns at once. Shows progress and categorises each campaign as Verified, Pending, or Postback (postback campaigns are exempt from the JS/server-side code check). At the end you can refresh the page to see updated Integration Status badges.

The Campaign Form — Key Sections

When you create or edit a campaign, the form has four tabs:

  • General Settings — Campaign Name, Tool Type (the tracking type: Sale Integration, Single Action Integration, Multi Action Integration, or Click Integration), Target URL, Tool Period (always running or with start/end dates), Categories, Country Location, Featured Image.
  • Level Settings — multi-level commission configuration.
  • Recurring Settings — recurring commission configuration.
  • Integration Setup — choose and configure the integration method (how conversions are tracked): Website (JS Pixel), S2S API (Server), Mobile App (S2S Direct), Postback, or Conversion API.

Tool Type vs Integration Method: The Tool Type in General Settings defines what is tracked (a sale, an action, or a click). The Integration Method in the Integration Setup tab defines how the tracking data is delivered (JS code, server-to-server call, postback URL, etc.). Both must be configured correctly.

Saving the Form

The form footer has two save buttons:

  • Save — saves the campaign and stays on the form (useful when you need to copy the generated API key or integration code after the first save).
  • Save & Close — saves the campaign and returns to the Campaigns list.

For existing campaigns the footer also shows a Get Code button — click it to open the integration code modal at any time without switching tabs.

For S2S API and Mobile App integrations, the API key and endpoint documentation only appear after you save the campaign at least once. Use the Save button (stay on form) so you can immediately copy the generated API key.

Was this article helpful?

56 views