Avantlink Connector

The Switchboard Avantlink connector provides automated access to the Avantlink APIs for Ad Search, Association Feed, Sales Commission Details, and Performance Summary

Prerequisites

To configure access to the Avantlink connector you will need the following properties:

API Key
See the AvantLink API documentation for details

Scheduling

The Avantlink 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.

The Avantlink AdSearch module provides access to merchant banner and text link campaigns configured in the AvantLink Affiliate Network.

Parameters

affiliate_id integer
required
An AvantLink assigned affiliate identifier.

Sample Switchboard Script

download t from {
                key: "avantlink_key";
                type: "avantlink:ad_search";
                affiliate_id: 56732;      //required
                website_id: 39873;    //required
} using {*};

Association Feed

The AvantLink AssociationFeed module provides functionality for retrieving the list of all merchants in AvantLink (with Id and categorization information) along with a status field indicating the association/relation of the requesting user to that merchant, e.g. “active”, “pending”, “denied”, “none”.

Parameters

affiliate_id integer
required
An AvantLink assigned affiliate identifier.

Sample Switchboard Script

download t from {
                key: "avantlink_key";
                type: "avantlink:ad_search";
                affiliate_id: 56732;      //required
                website_id: 39873;    //required
} using {*};

Sales Commission Details

Parameters

affiliate_id integer
required
An AvantLink assigned affiliate identifier.

Sample Switchboard Script

import avantlink_sales_commission_detail from {
    key: "avantlink_key";
    type: "avantlink:sales_commission_detail";
    affiliate_id: 12345;
} using {
    date: datetime;
    merchant: string;
    website: string;
    website_id: string;
    tool_name: string;
    campaign_product_link: string;
    coupon_code: string;
    customer_tracking_code: string;
    order_id: string;
    transaction_amount: string;
    base_commission: string;
    incentive_commission: string;
    total_commission: string;
    commission_status: string;
    transaction_type: string;
    transaction_date: datetime;
    last_click_through_date: datetime;
    mobile_order: string;
    new_customer: string;
    item_count: integer;
    avantLink_transaction_id: string;
    merchant_id: integer;
};

Performance Summary

Parameters

affiliate_id integer
required
An AvantLink assigned affiliate identifier.

Sample Switchboard Script

import avantlink_performance_summary from {
    key: "avantlink_key";
    type: "avantlink:performance_summary";
    affiliate_id: 12345;
} using {
    date: datetime;
    merchant: string;
    merchant_id: integer;
    ad_impressions: integer;
    click_through_count: integer;
    sales_revenue: string;
    sales_count: integer;
    mobile_sales_revenue: string;
    mobile_sales_count: integer;
    commissions: string;
    incentives: string;
    adjustment_count: integer;
    conversion_rate: string;
    new_customer_count: integer;
    new_customer_percentage: string;
    new_customer_sales: string;
    network_conversion_rate_30_day: string;
    average_sale_amount: string;
    click_through_rate: string;
    cpc_earnings: string;
    placement_earnings: string;
    ecpm: string;
    epc: string;
    total_commissions_earnings: string;
};