Example Queries: Daily Publisher Commission Report Service

The Daily Publisher Commission Report Service is a SOAP-based (Simple Object Access Protocol) API that enables developers to request publisher commission data from Commission Junction. Refer to the following use cases for examples of this service.

Use Case #1

The user would like a report of all transactions for the event date of January 19, 2007 for the Web site with a PID of 123456. The user would like to see the records sorted by commission amount in descending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

date

01/19/2007 (Required)

dateType

event (Required)

websiteId

123456

actionStatus

all

sortBy

commissionAmount

sortOrder

desc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://pubcommission.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:findPublisherCommissions>

         <api:developerKey></api:developerKey>

         <api:date>01/19/2007</api:date>

         <api:dateType>event</api:dateType>

         <api:advertiserIds></api:advertiserIds>

         <api:websiteIds>123456</api:websiteIds>

         <api:actionStatus>all</api:actionStatus>

         <api:actionTypes></api:actionTypes>

         <api:adIds></api:adIds>

         <api:countries></api:countries>

         <api:correctionStatus></api:correctionStatus>

         <api:sortBy>commissionAmount</api:sortBy>

         <api:sortOrder>desc</api:sortOrder>

      </api:findPublisherCommissions>

   </soapenv:Body>

</soapenv:Envelope>

Response

<ns1:PublisherCommission >

                  <actionStatus>closed</actionStatus>

                  <actionType>sale</actionType>

                  <adId>1030171</adId>

                  <advertiserId>276652</advertiserId>

                  <advertiserName>Zappos.com, Inc.</advertiserName>

                  <commissionAmount>263.354</commissionAmount>

                  <country/>

                  <eventDate >2007-01-19T16:22:30-08:00</eventDate>

                  <original>true</original>

                  <originalActionId>361532004</originalActionId>

                  <postingDate>2007-01-19T18:01:24-08:00</postingDate>

                  <sId>SearchAdWomen%27s+2007+shoesZappos17WomensAdGroup1</sId>

                  <saleAmount>1755.69</saleAmount>

                  <websiteId>123456</websiteId>

               </ns1:PublisherCommission>

Use Case #2

The user would like a report of all corrected transactions on February 15, 2007. The user would like to see the records sorted by commission amount in descending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

date

02/15/2007 (Required)

dateType

event (Required)

correctionStatus

corrected

sortBy

commissionAmount

sortOrder

desc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://pubcommission.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:findPublisherCommissions>

         <api:developerKey></api:developerKey>

         <api:date>02/15/2007</api:date>

         <api:dateType>event</api:dateType>

         <api:advertiserIds></api:advertiserIds>

         <api:websiteIds></api:websiteIds>

         <api:actionStatus></api:actionStatus>

         <api:actionTypes></api:actionTypes>

         <api:adIds></api:adIds>

         <api:countries></api:countries>

         <api:correctionStatus>corrected</api:correctionStatus>

         <api:sortBy>commissionAmount</api:sortBy>

         <api:sortOrder>desc</api:sortOrder>

      </api:findPublisherCommissions>

   </soapenv:Body>

</soapenv:Envelope>

Response

<ns1:PublisherCommission >

                  <actionStatus>closed</actionStatus>

                  <actionType>sale</actionType>

                  <adId>10289684</adId>

                  <advertiserId>7652</advertiserId>

                  <advertiserName>Zappos.com, Inc.</advertiserName>

                  <commissionAmount>-4.493</commissionAmount>

                  <country>US</country>

                  <eventDate >2007-02-15T07:48:49-08:00</eventDate>

                  <original>false</original>

                  <originalActionId>3731009</originalActionId>

                  <postingDate>2007-03-09T13:21:33-08:00</postingDate>

                  <sId>SearchAdOneWordHogan+Shoes</sId>

                  <saleAmount >-29.95</saleAmount>

                  <websiteId>123456</websiteId>

               </ns1:PublisherCommission>

Use Case #3

The user would like a report of all new transactions from yesterday (March 18, 2007) for a particular advertiser (CID 123456). The user would like to see the records sorted by sale amount in descending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

date

03/18/2007 (Required)

dateType

event (Required)

advertiserIds

123456

actionStatus

closed

sortBy

saleAmount

sortOrder

desc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://pubcommission.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:findPublisherCommissions>

         <api:developerKey></api:developerKey>

         <api:date>03/18/2007</api:date>

         <api:dateType>event</api:dateType>

         <api:advertiserIds>123456</api:advertiserIds>

         <api:websiteIds></api:websiteIds>

         <api:actionStatus>closed</api:actionStatus>

         <api:actionTypes></api:actionTypes>

         <api:adIds></api:adIds>

         <api:countries></api:countries>

         <api:correctionStatus>corrected</api:correctionStatus>

         <api:sortBy>saleAmount</api:sortBy>

         <api:sortOrder>desc</api:sortOrder>

      </api:findPublisherCommissions>

   </soapenv:Body>

</soapenv:Envelope>

Response

<ns1:PublisherCommission >

                  <actionStatus>closed</actionStatus>

                  <actionType>sale</actionType>

                  <adId>102894</adId>

                  <advertiserId>123456</advertiserId>

                  <advertiserName>Zappos.com, Inc.</advertiserName>

                  <commissionAmount>0</commissionAmount>

                  <country>US</country>

                  <eventDate >2007-03-18T06:32:50-07:00</eventDate>

                  <original>false</original>

                  <originalActionId>3869630</originalActionId>

                  <postingDate>2007-04-10T14:42:32-07:00</postingDate>

                  <sId>SearchAdStoSkTBD2Shelly+Shoes</sId>

                  <saleAmount>0</saleAmount>

                  <websiteId>45678</websiteId>

               </ns1:PublisherCommission>

Use Case #4

The user would like a report of all sale and advanced sale transaction for the event date of April 19, 2007 for a specific website (PID 123456). The user would like to see the records sorted by advertiser name in ascending order.

Request Parameter Specifications

Refer to the following table for the parameters required to satisfy the use case above.

Request Parameter

Value

developerKey

Your developer key (Required).

date

04/19/2007 (Required)

dateType

event (Required)

websiteId

123456

actionType

sale, advancedSale

sortBy

advertiserName

sortOrder

asc

Results

Refer to the following table for an example (code example) of results for the request parameters specified above.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="https://pubcommission.api.cj.com">

   <soapenv:Header/>

   <soapenv:Body>

      <api:findPublisherCommissions>

         <api:developerKey></api:developerKey>

         <api:date>03/18/2007</api:date>

         <api:dateType>event</api:dateType>

         <api:advertiserIds></api:advertiserIds>

         <api:websiteIds></api:websiteIds>

         <api:actionStatus></api:actionStatus>

         <api:actionTypes>sale, advanced sale</api:actionTypes>

         <api:adIds></api:adIds>

         <api:countries></api:countries>

         <api:correctionStatus></api:correctionStatus>

         <api:sortBy>advertiserName</api:sortBy>

         <api:sortOrder>asc</api:sortOrder>

      </api:findPublisherCommissions>

   </soapenv:Body>

</soapenv:Envelope>

Response:

<ns1:PublisherCommission >

                  <actionStatus>closed</actionStatus>

                  <actionType>advanced sale</actionType>

                  <adId>107322</adId>

                  <advertiserId>123456</advertiserId>

                  <advertiserName>Freemans PLC</advertiserName>

                  <commissionAmount>1.648</commissionAmount>

                  <country />

                  <eventDate>2007-03-18T00:01:00-07:00</eventDate>

                  <original>true</original>

                  <originalActionId>3935529</originalActionId>

                  <postingDate>2007-03-28T22:30:01-07:00</postingDate>

                  <sId >Free1</sId>

                  <saleAmount>16.478</saleAmount>

                  <websiteId>123456</websiteId>

               </ns1:PublisherCommission>

Response

<ns1:PublisherCommission >

                  <actionStatus>closed</actionStatus>

                  <actionType>advanced sale</actionType>

                  <adId>107322</adId>

                  <advertiserId>123456</advertiserId>

                  <advertiserName>Freemans PLC</advertiserName>

                  <commissionAmount>1.648</commissionAmount>

                  <country />

                  <eventDate>2007-03-18T00:01:00-07:00</eventDate>

                  <original>true</original>

                  <originalActionId>3935529</originalActionId>

                  <postingDate>2007-03-28T22:30:01-07:00</postingDate>

                  <sId >Free1</sId>

                  <saleAmount>16.478</saleAmount>

                  <websiteId>123456</websiteId>

               </ns1:PublisherCommission>