PepperJam

The Switchboard PepperJam connector provides automated reporting for payment and transaction reports.

Prerequisites

To configure access to the AvantLink Connector you need:

  • API Key

Scheduling

The PepperJam 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?
version A string denoting the PepperJam API version. Required

Sample Switchboard Script

import pepperjam_transaction_details from {
    type: "pepperjam_publisher:report_transaction_details";
    key: "pepperjam_key";
    version: "20120402";
} using {
	date: datetime;
	program_id: integer;
	program_name: string;
	order_id: integer;
	creative_type: string;
	transaction_id: integer;
	sale_amount: float;
	commission: float;
	status: string;
	type: string;
	sub_type: string;
	sid: string;
	new_to_file: string;
};



import pepperjam_transaction_delta from {
    type: "pepperjam_publisher:report_transaction_delta";
    key: "pepperjam_key";
    version: "20120402";
} using {
	date: datetime;
    item_id: integer;
	item_name: string;
	program_id: integer;
	program_name: string;
	order_id: integer;
	creative_type: string;
	reason: string;
	transaction_id: integer;
	sale_amount: float;
	commission: float;
	status: string;
	type: string;
	sub_type: string;
	sid: string;
};


import pepperjam_transaction_summary from {
    type: "pepperjam_publisher:report_transaction_summary";
    key: "pepperjam_key";
    version: "20120402";
} using {
	bonus_affiliate_commission: float;
	earnings_per_click: float;
	sale_count: integer;
	click_count: integer;
	total_commission: float;
	click_through_rate: integer;
	total_sale_commission: float;
	program_name: string;
	sale_revenue: float;
	total_lead_commission: float;
	conversion_rate: float;
	impression_count: integer;
	lead_count: integer;
};


import pepperjam_payment_report from {
    type: "pepperjam_publisher:report_payment";
    key: 'pepperjam_key';
    version: "20120402";
    day_of_month: [1];
} using {
	date: datetime;
	method: string;
	amount: float;
	payment_id: integer;
	notes: string;
};