Transaction Details API

This API is unlike other report APIs--the Transaction Details API is a "Streaming API". The API returns 1,000 records at a time. This allows the API framework to work efficiently amidst large volumes of transaction data. When a call is made, if more than 1,000 transaction records exist for the set criteria, a "NextRowId" will be returned in the XML response. The “NextRowId” is the ID for the first record of the next 1,000 records. By including this as the “StartID” parameter in the next call, the system will return the subsequent 1,000 records. For example, if a call was made which spanned 2,300 records, the system would return 1,000 records and the “NextRowId” of “7876”. When the next call was made, by including “7876” as the “StartId”, the system would return the next 1,000 records and a “NextRowId” of “8876”. When the next call was made, “8876” would be used as the “StartId” which would return the remaining 300 records and "0" would be returned as the “NextRowId”.

Base URL 

/v2/TransactionDetails

Parameters

StartDate - Required. This is the start date (starting point) to filter results by date.  Must be a valid date in the following format: MM/DD/YYYY.

EndDate - Required. This is the end date (endingpoint) to filter results by date.  Must be a valid date in the following format: MM/DD/YYYY.

CampaignId - Required. A valid Campaign ID from your account.

StartId - This is the Next Row ID value that is returned when the API is run for more than 1000 records. It is used to retrieve the next set of clicks.

Example URL

https://affiliateapi.linktrust.com/v2/TransactionDetails?CampaignId={Valid campaign ID}&startDate=10/31/2013&endDate=10/31/2013

Example XML Response

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"i:type="ConversionReport">
    <IsMoreAvailable>false</IsMoreAvailable>
    <NextRowId>0</NextRowId>
    <Transactions>
        <ConversionTransaction>
            <ADID>0</ADID>
            <AdditionalClickData/>
            <AffiliateRefID/>
            <Approval>Yes</Approval>
            <CID>100000</CID>
            <Date>11/05/2013 08:59:56</Date>
            <SID/>
            <TransactionID>PNO130-203146</TransactionID>
            <ClickCountry>US</ClickCountry>
            <ClickDate>11/05/2013 08:59:22</ClickDate>
            <ClickID>11_57_4d5a996f-4475-46de-be86-f32a6ef6d1df</ClickID>
            <ClickIPAddress>66.133.97.204</ClickIPAddress>
            <ClickReferrer/>
            <ClickUserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36
            </ClickUserAgent>
            <Commission>15.33</Commission>
            <ConversionCountry>US</ConversionCountry>
            <ConversionIPAddress>66.133.97.204</ConversionIPAddress>
            <ConversionReferrer/>
            <ConversionUserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36
            </ConversionUserAgent>
        </ConversionTransaction>
        <ConversionTransaction>
            <ADID>0</ADID>
            <AdditionalClickData/>
            <AffiliateRefID/>
            <Approval>No</Approval>
            <CID>100000</CID>
            <Date>11/05/2013 09:01:15</Date>
            <SID/>
            <TransactionID>PNO130-203147</TransactionID>
            <ClickCountry>US</ClickCountry>
            <ClickDate>11/05/2013 09:00:51</ClickDate>
            <ClickID>11_58_5fefd03e-f72c-4d10-990c-299ae0775e88</ClickID>
            <ClickIPAddress>66.133.97.204</ClickIPAddress>
            <ClickReferrer/>
            <ClickUserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36
            </ClickUserAgent>
            <Commission>15.33</Commission>
            <ConversionCountry>US</ConversionCountry>
            <ConversionIPAddress>66.133.97.204</ConversionIPAddress>
            <ConversionReferrer/>
            <ConversionUserAgent>Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36
            </ConversionUserAgent>
        </ConversionTransaction>
    </Transactions>
</z:anyType>

Example JSON Response

{
    Transactions: [2]0:  {
        Commission: "15.33"
        ClickDate: "11/05/2013 08:59:22"
        ClickID: "11_57_4d5a996f-4475-46de-be86-f32a6ef6d1df"
        ClickIPAddress: "66.133.97.204"
        ClickCountry: "US"
        ConversionIPAddress: "66.133.97.204"
        ConversionCountry: "US"
        ClickReferrer: ""
        ClickUserAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36"
        ConversionReferrer: ""
        ConversionUserAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36"
        TransactionID: "PNO130-203146"
        Date: "11/05/2013 08:59:56"
        CID: 100000
        Approval: "Yes"
        ADID: 0
        SID: ""
        AffiliateRefID: ""
        AdditionalClickData: [0]
    }
    -1: {
        Commission: "15.33"
        ClickDate: "11/05/2013 09:00:51"
        ClickID: "11_58_5fefd03e-f72c-4d10-990c-299ae0775e88"
        ClickIPAddress: "66.133.97.204"
        ClickCountry: "US"
        ConversionIPAddress: "66.133.97.204"
        ConversionCountry: "US"
        ClickReferrer: ""
        ClickUserAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36"
        ConversionReferrer: ""
        ConversionUserAgent: "Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/30.0.1599.101 Safari/537.36"
        TransactionID: "PNO130-203147"
        Date: "11/05/2013 09:01:15"
        CID: 100000
        Approval: "No"
        ADID: 0
        SID: ""
        AffiliateRefID: ""
        AdditionalClickData: [0]
    }
    IsMoreAvailable: false
    NextRowId: 0
}
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.