Webgains

The Switchboard Webgains connector provides automated reporting for performance summary and commision summary reports.

Prerequisites

To configure access to the Webgains Connector you need:

  • An Email Address and Password used to login to your Webgains account.

Scheduling

The Webgains connector can be scheduled to ingest data once per day at a user-defined hour and timezone. By default, the connector will run once at 6am PT. See Daily Scheduling for more information.

Parameters

Parameter Description Required/Optional?
campaign_id The numeric Avantlink account id. Required
report_type Allowed values are:

getDetailedEarnings
getFullEarnings
getFullEarningsWithCurrency
getFullEarningsWithEventName
getFullEarningsWithLockDate
getFullEarningsWithPaymentDate
getFullEarningsWithViewReference
getFullUpdatedEarnings		 Required

Sample Switchboard Script

import webgains_detailed_earnings from {
    type: "webgains";
    key: "webgains_key";
    report_type: "getDetailedEarnings";
} using {
    "eventID": integer;
    "linkID": string;
    "clickRef": string;
    "affiliateID": integer;
    "paymentStatus": string;
    "saleValue": float;
    "commission": float;
    "landingPage": string;
    "country": string;
    "changeReason": string;
    "campaignName": string;
    "campaignID": integer;
    "programName": string;
    "programID": integer;
    "clickthroughTime": datetime;
    "date": datetime;
    "validationDate": datetime;
    "delayedUntilDate": datetime;
    "status": string;
    "referrer": string;
};
   

import webgains_full_updated_earnings from {
    type: "webgains";
    key: "webgains_key";
    report_type: "getFullUpdatedEarnings";
    lookback_years: 3;
} using {
    "eventID": integer;
    "linkID": string;
    "clickRef": string;
    "affiliateID": integer;
    "paymentStatus": string;
    "saleValue": float;
    "commission": float;
    "landingPage": string;
    "country": string;
    "changeReason": string;
    "campaignName": string;
    "campaignID": integer;
    "programName": string;
    "programID": integer;
    "clickthroughTime": datetime;
    "date": datetime;
    "validationDate": datetime;
    "delayedUntilDate": datetime;
    "status": string;
    "referrer": string;
};



import webgains_full_earnings_with_lock_date from {
    type: "webgains";
    key: "webgains_key";
    report_type: "getFullEarningsWithLockDate";
    lookback_years: 3;
} using {
    "eventID": integer;
	"transactionID": integer;
    "linkID": string;
    "clickRef": string;
    "affiliateID": integer;
    "paymentStatus": string;
    "saleValue": float;
    "commission": float;
    "landingPage": string;
    "country": string;
    "changeReason": string;
    "campaignName": string;
    "campaignID": integer;
    "programName": string;
    "programID": integer;
    "clickthroughTime": datetime;
    "date": datetime;
    "validationDate": datetime;
    "delayedUntilDate": datetime;
	"lockDate": datetime;
    "status": string;
    "referrer": string;
};