Channel Breakout by Merchant API

Results from this API will show the lead gen performance stats for a given advertiser, broken out by channel and then affiliate.

Base URL 

/API/v2/Reports/ChannelBreakoutByMerchant

Parameters

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

EndDate - Required.  The end date (ending point) to filter results by date.  Needs to be a date in the following format: MM/DD/YYYY

TrafficFilterChannelStats - Required.  Used to filter the results by lead status.  Can be one of the following integers or strings:

  • "All" or "1" (No Traffic Filtering)
  • "InvalidDataField" or "2" (Filtering by Invalid Data Field)
  • "CampaignRules" or "3" (Filtering by Campaign Rules)
  • "ThirdPartyRules" or "4" (Filtering by Third Party Rules)
  • "TierRules" or "5" (Filtering by Tier Rules)
  • "ChannelRules" or "6" (Filtering by Channel Rules)
  • "RejectedResponse" or "7" (Filtering by Rejected Response)

MerchantId - Required.  The ID for the advertiser you want to view stats for.

Example URL

https://api.linktrust.com/v2/Reports/ChannelBreakoutByMerchant?StartDate=10/09/2013&EndDate=10/09/2013&TrafficFilterChannelStats=1&MerchantId=1000

Example XML Response

<ChannelBreakoutByMerchantReportResult>
    <ChannelBreakoutByMerchant>
        <ParentRow>
            <Stats>
                <Accepted>2</Accepted>
                <Approved>2</Approved>
                <Attempts>5</Attempts>
                <Margin>74.5162</Margin>
                <Qualified>2</Qualified>
                <RejectedError>1</RejectedError>
                <RejectedResponse>0</RejectedResponse>
                <RejectedRule>0</RejectedRule>
                <RejectedTimeout>0</RejectedTimeout>
                <ReturnRate>1</ReturnRate>
                <Returned>2</Returned>
                <TotalAffiliateCommission>29.1366</TotalAffiliateCommission>
                <TotalRevenue>103.6528</TotalRevenue>
                <CHID>136</CHID>
                <CID>100197</CID>
                <CampaignName>**Bret's Lead Campaign</CampaignName>
                <ChannelName>5rea</ChannelName>
                <Enabled>true</Enabled>
                <Type>Post</Type>
            </Stats>
            <Children>
                <Child>
                    <Accepted>2</Accepted>
                    <Approved>2</Approved>
                    <Attempts>5</Attempts>
                    <Margin>74.5162</Margin>
                    <Qualified>2</Qualified>
                    <RejectedError>1</RejectedError>
                    <RejectedResponse>0</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>1</ReturnRate>
                    <Returned>2</Returned>
                    <TotalAffiliateCommission>29.1366</TotalAffiliateCommission>
                    <TotalRevenue>103.6528</TotalRevenue>
                    <AFID>100030</AFID>
                    <AffiliateName>*Dr Pepper</AffiliateName>
                    <Suspended>false</Suspended>
                </Child>
            </Children>
        </ParentRow>
        <ParentRow>
            <Stats>
                <Accepted>8</Accepted>
                <Approved>3</Approved>
                <Attempts>11</Attempts>
                <Margin>25.0000</Margin>
                <Qualified>4</Qualified>
                <RejectedError>0</RejectedError>
                <RejectedResponse>0</RejectedResponse>
                <RejectedRule>0</RejectedRule>
                <RejectedTimeout>0</RejectedTimeout>
                <ReturnRate>0.375</ReturnRate>
                <Returned>3</Returned>
                <TotalAffiliateCommission>15.0000</TotalAffiliateCommission>
                <TotalRevenue>40.0000</TotalRevenue>
                <CHID>139</CHID>
                <CID>100197</CID>
                <CampaignName>**Bret's Lead Campaign</CampaignName>
                <ChannelName>Albert</ChannelName>
                <Enabled>true</Enabled>
                <Type>Post</Type>
            </Stats>
            <Children>
                <Child>
                    <Accepted>0</Accepted>
                    <Approved>0</Approved>
                    <Attempts>1</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>0</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>0</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>1</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <AFID>100004</AFID>
                    <AffiliateName>#1 Best Affiliate, Inc.</AffiliateName>
                    <Suspended>false</Suspended>
                </Child>
                <Child>
                    <Accepted>8</Accepted>
                    <Approved>3</Approved>
                    <Attempts>10</Attempts>
                    <Margin>25.0000</Margin>
                    <Qualified>4</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>0</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0.25</ReturnRate>
                    <Returned>2</Returned>
                    <TotalAffiliateCommission>15.0000</TotalAffiliateCommission>
                    <TotalRevenue>40.0000</TotalRevenue>
                    <AFID>100030</AFID>
                    <AffiliateName>*Dr Pepper</AffiliateName>
                    <Suspended>false</Suspended>
                </Child>
            </Children>
        </ParentRow>
    </ChannelBreakoutByMerchant>
</ChannelBreakoutByMerchantReportResult>

Example JSON Response

{
   "ChannelBreakoutByMerchant":[
      {
         "Stats":{
            "CID":100197,
            "CampaignName":"Lead Gen Campaign 1",
            "CHID":136,
            "ChannelName":"Channel 1",
            "Type":"Post",
            "Enabled":true,
            "Attempts":5,
            "RejectedRule":0,
            "RejectedTimeout":0,
            "RejectedError":1,
            "RejectedResponse":0,
            "Qualified":2,
            "Approved":2,
            "TotalAffiliateCommission":29.1366,
            "Accepted":2,
            "Returned":2,
            "ReturnRate":1.0,
            "TotalRevenue":103.6528,
            "Margin":74.5162
         }
         "Children":[
            {
               "AFID":100030,
               "AffiliateName":"ACME Inc",
               "Suspended":false,
               "Attempts":5
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":1,
               "RejectedResponse":0,
               "Qualified":2,
               "Approved":2,
               "TotalAffiliateCommission":29.1366,
               "Accepted":2,
               "Returned":2,
               "ReturnRate":1.0,
               "TotalRevenue":103.6528,
               "Margin":74.5162
            }
         ]
      },
      {
         "Stats":{
            "CID":100197,
            "CampaignName":"Campaign 1",
            "CHID":139,
            "ChannelName":"Channel 1",
            "Type":"Post",
            "Enabled":true,
            "Attempts":11,
            "RejectedRule":0,
            "RejectedTimeout":0,
            "RejectedError":0,
            "RejectedResponse":0,
            "Qualified":4,
            "Approved":3,
            "TotalAffiliateCommission":15.0000,
            "Accepted":8,
            "Returned":3,
            "ReturnRate":0.375,
            "TotalRevenue":40.0000,
            "Margin":25.0000
         },
         "Children":[
            {
               "AFID":100004,
               "AffiliateName":"Acme Inc 2",
               "Suspended":false,
               "Attempts":1,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":0,
               "Qualified":0,
               "Approved":0,
               "TotalAffiliateCommission":0.0000,
               "Accepted":0,
               "Returned":1,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.0000
            },
            {
               "AFID":100030,
               "AffiliateName":"Acme Inc 3",
               "Suspended":false,
               "Attempts":10,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":0,
               "Qualified":4,
               "Approved":3,
               "TotalAffiliateCommission":15.0000,
               "Accepted":8,
               "Returned":2,
               "ReturnRate":0.25,
               "TotalRevenue":40.0000,
               "Margin":25.0000
            }
         ]
      }
   ]
}
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.