Version 2 - Partner
      Back to home
      1. Help Center
      2. API's
      3. Version 2 - Partner

      Channel Breakout By Campaign API

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

      Base URL 

      /v2/Reports/ChannelBreakoutByCampaign

      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)

      CampaignId - Required.  The ID for the campaign you want to view stats for.

      Example URL

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

      Example XML Response

      <ChannelBreakoutByCampaignReportResult>

      <ChannelBreakoutByCampaign>

      <ParentRow>

      <Stats>

      <Accepted>3</Accepted>

      <Approved>3</Approved>

      <Attempts>4</Attempts>

      <Margin>6.0000</Margin>

      <Qualified>3</Qualified>

      <RejectedError>1</RejectedError>

      <RejectedResponse>0</RejectedResponse>

      <RejectedRule>0</RejectedRule>

      <RejectedTimeout>0</RejectedTimeout>

      <ReturnRate>0</ReturnRate>

      <Returned>0</Returned>

      <TotalAffiliateCommission>60.0000</TotalAffiliateCommission>

      <TotalRevenue>66.0000</TotalRevenue>

      <CHID>136</CHID>

      <CID>100197</CID>

      <CampaignName>Campaign1</CampaignName>

      <ChannelName>5rea</ChannelName>

      <Enabled>true</Enabled>

      <Type>Post</Type>

      </Stats>

      <Children>

      <Child>

      <Accepted>3</Accepted>

      <Approved>3</Approved>

      <Attempts>4</Attempts>

      <Margin>6.0000</Margin>

      <Qualified>3</Qualified>

      <RejectedError>1</RejectedError>

      <RejectedResponse>0</RejectedResponse>

      <RejectedRule>0</RejectedRule>

      <RejectedTimeout>0</RejectedTimeout>

      <ReturnRate>0</ReturnRate>

      <Returned>0</Returned>

      <TotalAffiliateCommission>60.0000</TotalAffiliateCommission>

      <TotalRevenue>66.0000</TotalRevenue>

      <AFID>100030</AFID>

      <AffiliateName>Aceme Inc</AffiliateName>

      <Suspended>false</Suspended>

      </Child>

      </Children>

      </ParentRow>

      <ParentRow>

      <Stats>

      <Accepted>6</Accepted>

      <Approved>2</Approved>

      <Attempts>9</Attempts>

      <Margin>10.0000</Margin>

      <Qualified>2</Qualified>

      <RejectedError>0</RejectedError>

      <RejectedResponse>0</RejectedResponse>

      <RejectedRule>0</RejectedRule>

      <RejectedTimeout>0</RejectedTimeout>

      <ReturnRate>0.5</ReturnRate>

      <Returned>3</Returned>

      <TotalAffiliateCommission>10.0000</TotalAffiliateCommission>

      <TotalRevenue>20.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>#1Best Affiliate, Inc.</AffiliateName>

      <Suspended>false</Suspended>

      </Child>

      <Child>

      <Accepted>6</Accepted>

      <Approved>2</Approved>

      <Attempts>8</Attempts>

      <Margin>10.0000</Margin>

      <Qualified>2</Qualified>

      <RejectedError>0</RejectedError>

      <RejectedResponse>0</RejectedResponse>

      <RejectedRule>0</RejectedRule>

      <RejectedTimeout>0</RejectedTimeout>

      <ReturnRate>0.25</ReturnRate>

      <Returned>2</Returned>

      <TotalAffiliateCommission>10.0000</TotalAffiliateCommission>

      <TotalRevenue>20.0000</TotalRevenue>

      <AFID>100030</AFID>

      <AffiliateName>Acme Inc</AffiliateName>

      <Suspended>false</Suspended>

      </Child>

      </Children>

      </ParentRow>

      </ChannelBreakoutByCampaign>

      </ChannelBreakoutByCampaignReportResult>

      Example JSON Response
      {
         "ChannelBreakoutByCampaign":[
      {
      "Stats":{
      "CID":100197,
      "CampaignName":"**Bret's Lead Campaign",
      "CHID":136,
      "ChannelName":"5reallylongname55551111111111132132132132132132132",
      "Type":"Post",
      "Enabled":true,
      "Attempts":4,
      "RejectedRule":0,
      "RejectedTimeout":0,
      "RejectedError":1,
      "RejectedResponse":0,
      "Qualified":3,
      "Approved":3,
      "TotalAffiliateCommission":60.0000,
      "Accepted":3,
      "Returned":0,
      "ReturnRate":0.0,
      "TotalRevenue":66.0000,
      "Margin":6.0000
      },
      "Children":[
      {
      "AFID":100030,
      "AffiliateName":"*Dr Pepper",
      "Suspended":false,
      "Attempts":4,
      "RejectedRule":0,
      "RejectedTimeout":0,
      "RejectedError":1,
      "RejectedResponse":0,
      "Qualified":3,
      "Approved":3,
      "TotalAffiliateCommission":60.0000,
      "Accepted":3,
      "Returned":0,
      "ReturnRate":0.0,
      "TotalRevenue":66.0000,
      "Margin":6.0000
      }
      ]
      },
      {
      "Stats":{
      "CID":100197,
      "CampaignName":"**Bret's Lead Campaign",
      "CHID":139,
      "ChannelName":"Albert",
      "Type":"Post",
      "Enabled":true,
      "Attempts":9,
      "RejectedRule":0,
      "RejectedTimeout":0,
      "RejectedError":0,
      "RejectedResponse":0,
      "Qualified":2,
      "Approved":2,
      "TotalAffiliateCommission":10.0000,
      "Accepted":6,
      "Returned":3,
      "ReturnRate":0.5,
      "TotalRevenue":20.0000,
      "Margin":10.0000
      },
      "Children":[
      {
      "AFID":100004,
      "AffiliateName":"#1 Best Affiliate, Inc.",
      "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":"*Dr Pepper",
      "Suspended":false,
      "Attempts":8,
      "RejectedRule":0,
      "RejectedTimeout":0,
      "RejectedError":0,
      "RejectedResponse":0,
      "Qualified":2,
      "Approved":2,
      "TotalAffiliateCommission":10.0000,
      "Accepted":6,
      "Returned":2,
      "ReturnRate":0.3333333333333333333333333333,
      "TotalRevenue":20.0000,
      "Margin":10.0000
      }
      ]
      }
      ]
      }

       

      You can request a demo to see LinkTrust up close and experience how it can help you, or start your free 14-day trial now.


      Need help with this feature or have questions? You can contact our support team at support@linktrust.com