Skimlinks

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

Prerequisites

To configure access to the Skimlinks Connector you need:

  • Your Skimlinks Publisher ID
  • Client Id
  • Client Secret

To obtain your Client Id and Secret, contact your Skimlinks Account Manager.

Scheduling

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

Aggregated Reports

Parameters

Parameter Description Required/Optional?
dimension A list of optional dimension breakdowns.
Allowed values are:

date
device
country
domain
link
merchant		 Optional

Sample Switchboard Script

import aggregated_reports from {
    type: "skimlinks:aggregated_reports";
    key: "skimlinks_key";
} using {
    isodate: datetime;
    publisher_commission_amount: float;
    clicks_affiliated: integer;
    sales: integer;
    ctr_affiliated: float;
    conversion_rate: float;
    impressions: integer;
    order_amount: float;
    rpm: float;
    epc: float;    
};

Individual Commission Reports

Parameters

Parameter Description Required/Optional?
use_updated_since When set to true, restricts data range of pull to that of the previous day. Optional

Sample Switchboard Script

import skimlinks_commissions from {
    type: "skimlinks:individual_commissions";
    key: "skimlinks_key";
} using {
    commission_id: integer;
    transaction_details: {
        basket: {
            currency: string;
            commission_type: string;
            publisher_amount: float;
            order_amount: float;
            items: integer;
        };
        status: string;
        transaction_date: datetime;
        last_updated: datetime;
        payment_status: string;
    };
    merchant_details: {
        name: string;
        id: integer;
    };
    click_details: {
        clicked_url: string;
        custom_id: string;
        user_country: string;
        user_agent: string;
        date: datetime;
        page_url: string;
    };
    publisher_domain_id: integer;
    publisher_id: integer;
};