Channel Performance API

Results from this API will show the lead gen performance stats for each campaign, broken out by channel.

Base URL 

/API/v2/Reports/ChannelPerformance

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)

AffiliateId - Not required.  If you pass in a valid AFID, the returns will be filtered by that affiliate.

Example URL

https://api.linktrust.com/v2/Reports/ChannelPerformance?StartDate=10/09/2013&EndDate=10/09/2013&TrafficFilterChannelStats=1&AffiliateId=10000

Example XML Response

<ChannelPerformanceReportResult>
    <ChannelPerformance>
        <ParentRow>
            <Stats>
                <Accepted>9</Accepted>
                <Approved>0</Approved>
                <Attempts>36</Attempts>
                <Margin>0.0000</Margin>
                <Qualified>9</Qualified>
                <RejectedError>0</RejectedError>
                <RejectedResponse>27</RejectedResponse>
                <RejectedRule>0</RejectedRule>
                <RejectedTimeout>0</RejectedTimeout>
                <ReturnRate>0</ReturnRate>
                <Returned>0</Returned>
                <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                <TotalRevenue>0.0000</TotalRevenue>
                <CID>100204</CID>
                <CampaignName>*Nathan's Lead Gen Test</CampaignName>
            </Stats>
            <Children>
                <Child>
                    <Accepted>0</Accepted>
                    <Approved>0</Approved>
                    <Attempts>1</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>0</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>1</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>0</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <CHNID>143</CHNID>
                    <ChannelName>Nate Wade - Ping</ChannelName>
                    <Enabled>true</Enabled>
                    <MerchantId>100051</MerchantId>
                    <MerchantName>Gavin</MerchantName>
                    <Type>Ping</Type>
                </Child>
                <Child>
                    <Accepted>9</Accepted>
                    <Approved>0</Approved>
                    <Attempts>17</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>9</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>8</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>0</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <CHNID>144</CHNID>
                    <ChannelName>Nate Wade - Post</ChannelName>
                    <Enabled>true</Enabled>
                    <MerchantId>100050</MerchantId>
                    <MerchantName>Nates Money Maker</MerchantName>
                    <Type>Post</Type>
                </Child>
                <Child>
                    <Accepted>0</Accepted>
                    <Approved>0</Approved>
                    <Attempts>1</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>0</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>1</RejectedResponse>
                    <RejectedRule>0</RejectedRule> 
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>0</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <CHNID>145</CHNID>
                    <ChannelName>Stockton 12 - Ping</ChannelName>
                    <Enabled>true</Enabled>
                    <MerchantId>100042</MerchantId>
                    <MerchantName>Neopolis</MerchantName>
                    <Type>Ping</Type>
                </Child>
                <Child>
                    <Accepted>0</Accepted>
                    <Approved>0</Approved>
                    <Attempts>8</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>0</Qualified>
                    <RejectedError>0</RejectedError>
                    <RejectedResponse>8</RejectedResponse>
                    <RejectedRule>0</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>0</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <CHNID>146</CHNID>
                    <ChannelName>Stockton 12 - Post</ChannelName>
                    <Enabled>true</Enabled>
                    <MerchantId>100008</MerchantId>
                    <MerchantName>Progress Click</MerchantName>
                    <Type>Post</Type>
                </Child>
            </Children>
        </ParentRow>
        <ParentRow>
            <Stats>
                <Accepted>15</Accepted>
                <Approved>15</Approved>
                <Attempts>25</Attempts>
                <Margin>0.0000</Margin>
                <Qualified>15</Qualified>
                <RejectedError>5</RejectedError>
                <RejectedResponse>0</RejectedResponse>
                <RejectedRule>5</RejectedRule>
                <RejectedTimeout>0</RejectedTimeout>
                <ReturnRate>0</ReturnRate>
                <Returned>0</Returned>
                <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                <TotalRevenue>0.0000</TotalRevenue>
                <CID>100206</CID>
                <CampaignName>Lead Galore</CampaignName>
            </Stats>
            <Children>
                <Child>
                    <Accepted>15</Accepted>
                    <Approved>15</Approved>
                    <Attempts>25</Attempts>
                    <Margin>0.0000</Margin>
                    <Qualified>15</Qualified>
                    <RejectedError>5</RejectedError>
                    <RejectedResponse>0</RejectedResponse>
                    <RejectedRule>5</RejectedRule>
                    <RejectedTimeout>0</RejectedTimeout>
                    <ReturnRate>0</ReturnRate>
                    <Returned>0</Returned>
                    <TotalAffiliateCommission>0.0000</TotalAffiliateCommission>
                    <TotalRevenue>0.0000</TotalRevenue>
                    <CHNID>205</CHNID>
                    <ChannelName>channel2</ChannelName>
                    <Enabled>true</Enabled>
                    <MerchantId>100033</MerchantId>
                    <MerchantName>BretTest</MerchantName>
                    <Type>Post</Type>
                </Child>
            </Children>
        </ParentRow>
    </ChannelPerformance>
</ChannelPerformanceReportResult>

Example JSON Response

{
  "ChannelPerformance":[

      {
         "Stats":{
            "CID":100204,
            "CampaignName":"*Nathan's Lead Gen Test",
            "Attempts":36,
            "RejectedRule":0,
            "RejectedTimeout":0,
            "RejectedError":0,
            "RejectedResponse":27,
            "Qualified":9,
            "Approved":0,
            "TotalAffiliateCommission":0.0000,
            "Accepted":9,
            "Returned":0,
            "ReturnRate":0.0,
            "TotalRevenue":0.0000,
            "Margin":0.0000
         },
         "Children":[
            {
               "CHNID":143,
               "ChannelName":"Nate Wade - Ping",
               "Type":"Ping",
               "MerchantName":"Gavin",
               "MerchantId":100051,
               "Enabled":true,
               "Attempts":1,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":1,
               "Qualified":0,
               "Approved":0,
               "TotalAffiliateCommission":0.0000,
               "Accepted":0,
               "Returned":0,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.0000
            },
            {
               "CHNID":144,
               "ChannelName":"Nate Wade - Post",
               "Type":"Post",
               "MerchantName":"Nates Money Maker",
               "MerchantId":100050,
               "Enabled":true,
               "Attempts":17,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":8,
               "Qualified":9,
               "Approved":0,
               "TotalAffiliateCommission":0.0000,
               "Accepted":9,
               "Returned":0,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.0000
            },
            {
               "CHNID":145,
               "ChannelName":"Stockton 12 - Ping",
               "Type":"Ping",
               "MerchantName":"Neopolis",
               "MerchantId":100042,
               "Enabled":true,
               "Attempts":1,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":1,
               "Qualified":0,
               "Approved":0,
               "TotalAffiliateCommission":0.0000,
               "Accepted":0,
               "Returned":0,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.0000
            },
            {
               "CHNID":146,
               "ChannelName":"Stockton 12 - Post",
               "Type":"Post",
               "MerchantName":"Progress Click",
               "MerchantId":100008,
               "Enabled":true,
               "Attempts":8,
               "RejectedRule":0,
               "RejectedTimeout":0,
               "RejectedError":0,
               "RejectedResponse":8,
               "Qualified":0,
               "Approved":0,
               "TotalAffiliateCommission":0.0000,
               "Accepted":0,
               "Returned":0,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.0000
            }
         ]
      },
      {
         "Stats":{
            "CID":100206,
            "CampaignName":"Lead Galore",
            "Attempts":25,
            "RejectedRule":5,
            "RejectedTimeout":0,
            "RejectedError":5,
            "RejectedResponse":0,
            "Qualified":15,
            "Approved":15,
            "TotalAffiliateCommission":0.0000,
            "Accepted":15,
            "Returned":0,
            "ReturnRate":0.0,
            "TotalRevenue":0.0000,
            "Margin":0.0000
         },
         "Children":[
            {
               "CHNID":205,
               "ChannelName":"channel2",
               "Type":"Post",
               "MerchantName":"BretTest",
               "MerchantId":100033,
               "Enabled":true,
               "Attempts":25,
               "RejectedRule":5,
               "RejectedTimeout":0,
               "RejectedError":5,
               "RejectedResponse":0,
               "Qualified":15,
               "Approved":15,
               "TotalAffiliateCommission":0.0000,
               "Accepted":15,
               "Returned":0,
               "ReturnRate":0.0,
               "TotalRevenue":0.0000,
               "Margin":0.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.