CJ Affiliate (Commission Junction)

The Switchboard Commission Junction connector automates access to Advertiser and Publisher Commission reports.

Prerequisites
Scheduling
Report Types
Switchboard Script Syntax
- Parameters

Prerequisites

To configure access to the Switchboard Commission Junction Connector, you need:

Personal Access Token - The credential used to access automated Commission Junction reports.
Company ID - The value is specific to your Commission Junction account.

To obtain these credentials, contact your Commission Junction Account Manager.

Scheduling

Commission Junction Connector can be scheduled to run multiple times a day at a user-defined hour and timezone.

To configure this schedule, use the delay_hours parameter.
By default, the connector will run once at 6am PT.

Report Types

The following report types are available:

commission_junction:publisherCommissions
commission_junction:advertisers

Switchboard Script Syntax

import commission_junction_raw from {
    type: "commission_junction:publisherCommissions";
    key: "commission_junction_key";
    date_filter: "Posting";
    company_id: "012345";
    metrics: [
        "advertiserId",
        "advertiserName",
        "clickDate",
        "clickReferringURL",
        "commissionId",
        "country",
        "eventDate",
        "items",
        "lockingDate",
        "orderDiscountUsd",
        "orderId",
        "original",
        "originalActionId",
        "postingDate",
        "pubCommissionAmountPubCurrency",
        "pubCommissionAmountUsd",
        "publisherId",
        "publisherName",
        "saleAmountPubCurrency",
        "saleAmountUsd",
        "shopperId",
        "source",
        "websiteId",
        "websiteName"
	   ];
} using {
        "advertiserId": integer;
        "advertiserName": string;
        "clickDate": datetime;
        "clickReferringURL": string;
        "commissionId": integer;
        "country": string;
        "eventDate": datetime;
        "originalActionId": integer;
        "saleAmountUsd": float;
        "pubCommissionAmountUsd": float;
        "items": json;
        "lockingDate": datetime;
        "orderDiscountUsd": float;
        "orderId": integer;
        "postingDate": datetime;
        "publisherId": integer;
        "publisherName": string;
        "shopperId": integer;
        "source": string;
        "websiteId": integer;
        "websiteName": string;
}; 

Parameters

Parameter	Description	Required/Optional?
date_filter	A filter used on how report dates should be returned. Currently, "Event", "Locking," and "Posting" values are supported.	Required
metrics	A list of requested metrics. For metrics descriptions, see Commission Detail API Reference Documentation.	Required
company_id	The company ID specific to your reports. For Example: company_id:012345;	Required