Publisher Commission Service

The Daily Publisher Commission Service is a SOAP API that enables developers to request publisher commission data from Commission Junction. Developers may request data using multiple parameters to return specific results based on those request parameters (e.g., You may request commissions related to a specific advertiser on a specific date). The most current data available through this report is the data from the previous day. It is not possible to get the data for the current day using this API.

Request Parameters

Refer to the following table for a list of the required and optional request parameters. All parameter names and values are case sensitive.

Parameter Name	Value	Req?	Description
developerKey	String	Required	Your developer key obtained from the Web Services Developer Site.
date	String	Required	Use this parameter to specify an exact date for the request. You must enter dates in the MM/DD/YYYY format and may only contain past dates. Note: The most current data available through this report is the data from the previous day. It is not possible to get the data for the current day using this API.
dateType	String	Required	Use this parameter to specify the date parameter as one of the following. Event: Specifies the date as the event date. Posting: Specifies the date as the posting date.
advertiserIds	Long	Optional	Limits the results to a set of particular advertisers (CIDs) using one of the following four values. CIDs: You may provide list of one or more advertiser CIDs, separated by commas, to limit the results to a specific sub-set of merchants. Empty String: You may provide an empty string to remove any advertiser-specific restrictions on the search.
websiteIds	String	Optional	Limits the results to a particular Web site or set of Web Sites. You may enter a single Web site ID or multiple Web site IDs separated by commas. Leaving this field blank or specifying 'all' returns results for all websites.
actionStatus	String	Optional	Limits the results to actions of a specific status. Status options include the following. all new extended closed locked
actionTypes	String	Optional	Limits the results to a specific type of action. Action types include the following. bonus click impression sale lead advanced sale advanced lead performance incentive Note: You may use comma separated values. Note: For this request parameter to return data, you must have an action of one or more of these types in a program term.
adIds	Long	Optional	Limits the results to the ID for a specific ad. You may enter a single Ad ID or multiple Ad IDs separated by commas. Leaving this field blank or specifying 'all' returns results for all Ad IDs.
countries	String	Optional	Limits the results to a country of origin of the advertisers. You may enter a single ISO country code or multiple ISO country codes separated by commas. Leaving this field blank or specifying 'all' returns results for all countries.
correctionStatus	String	Optional	Limits the results to transactions of a specific status; the following values are acceptable. corrected not corrected
sortBy	String	Optional	Sort the results by any of the following response fields. actionStatus actionType adId advertiserId advertiserName commissionAmount country eventDate orginal originalActionId postingDate sId saleAmount websiteId
sortOrder	String	Optional	Specifies the order in which the results are sorted; the following vales are acceptable. asc: ascending desc: descending Note: Leaving the sortOrder blank returns the natural order of the records in the response.

Response Fields

The response includes information about the general response, as well as specific information for each record in the response.

General

The response includes the following information about the overall set of results in the response.

Field Name	Value	Description
totalResults	Long	The total number of records in the response.
sortBy	String	The field through which results are sorted.
Publisher Commission Data	Array	An array of Publisher Commission Data records. Refer to the Per Record Results table for information regarding what is returned for each record of the Publisher Commission Data.

Per Record Results

The response includes the following fields for each record of Publisher Commission Data.

Field Name	Value	Description
actionStatus	String	The associated action status for the item.
actionType	String	The associated action type for the item.
adId	Long	The associated ad identification number.
advertiserId	Long	The associated advertiser's identification number.
advertiserName	String	The associated advertiser's program name.
commissionAmount	Double	The associated publisher commission amount.
country	String	The country where the associated transaction occurred.
eventDate	Date	The associated event date for the item in UTC time zone.
lockingDate	Date	The associated date on which the commission is locked for extending or correcting.
orderID	Long	The associated advertiser-assigned ID number for the transaction.
original	Boolean	Displays either a '1' indicating an original transaction or a '0' indicating a non-original or correction transaction.
originalActionId	Long	The identification number used for correlation between the original transaction and corrections.
postingDate	Date	The associated post date for the item.
sId	Long	The associated publisher surfer identification number.
saleAmount	Double	The associated advertiser sale amount.
transactionID	Long	The associated ID number assigned to the transaction by Commission Junction.
websiteId	Long	The associated publisher Web site identification number.

Errors

Error	Description
No Results Returned	The system could not find any information for the specified parameters.
Not Authenticated	The system could not authenticate your developer key.
Invalid Request	One or more of the request parameters contains an invalid value. Returns the parameter with the invalid value.