Campaign Lead Status API

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

Base URL 

/v2/Reports/CampaignLeadStatus

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

TrafficFilterLeadStats - 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)

Example URL

https://api.linktrust.com/v2/Reports/CampaignLeadStatus?StartDate=10/09/2013&EndDate=10/09/2013 &TrafficFilterLeadStats=1

Example XML Response

<CampaignLeadStatusReportResult>
    <CampaignLeadStatus>
        <ParentRow>
            <Stats>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>0</FilteredCampaignRules>
                <FilteredInvalidDataField>23</FilteredInvalidDataField>
                <Gross>23</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>0</RejectedResponse>
                <RejectedTierRules>0</RejectedTierRules>
                <RejectedTotal>0</RejectedTotal>
                <ReturnedFromAll>0</ReturnedFromAll>
                <Sold>0</Sold>
                <CID>100197</CID>
                <CampaignName>**Bret's Lead Campaign</CampaignName>
            </Stats>
        <Children>
            <Child>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>0</FilteredCampaignRules>
                <FilteredInvalidDataField>23</FilteredInvalidDataField>
                <Gross>23</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>0</RejectedResponse>
                <RejectedTierRules>0</RejectedTierRules>
                <RejectedTotal>0</RejectedTotal>
                <ReturnedFromAll>0</ReturnedFromAll>
                <Sold>0</Sold>
                <AFID>100004</AFID>
                <Name>#1 Best Affiliate, Inc.</Name>   
                <Suspended>false</Suspended>
            </Child>
            <Child>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>5</FilteredCampaignRules>
                <FilteredInvalidDataField>0</FilteredInvalidDataField>
                <Gross>23</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>8</RejectedResponse>
                <RejectedTierRules>1</RejectedTierRules>
                <RejectedTotal>9</RejectedTotal>
                <ReturnedFromAll>0</ReturnedFromAll>
                <Sold>9</Sold>
                <AFID>100014</AFID>
                <Name>Nathan's Test Affiliate</Name>
                <Suspended>false</Suspended>
            </Child>
            </Children>
        </ParentRow>
        <ParentRow>
            <Stats>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>1</FilteredCampaignRules>
                <FilteredInvalidDataField>0</FilteredInvalidDataField>
                <Gross>28</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>10</RejectedResponse>
                <RejectedTierRules>2</RejectedTierRules>
                <RejectedTotal>12</RejectedTotal>
                <ReturnedFromAll>0</ReturnedFromAll>
                <Sold>15</Sold>
                <CID>100206</CID>
                <CampaignName>Lead Galore</CampaignName>
            </Stats>
            <Children>
                <Child>
                    <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                    <FilteredCampaignRules>1</FilteredCampaignRules>
                    <FilteredInvalidDataField>0</FilteredInvalidDataField>
                    <Gross>28</Gross>
                    <RejectedChannelRules>0</RejectedChannelRules>
                    <RejectedResponse>10</RejectedResponse>
                    <RejectedTierRules>2</RejectedTierRules>
                    <RejectedTotal>12</RejectedTotal>
                    <ReturnedFromAll>0</ReturnedFromAll>
                    <Sold>15</Sold>
                    <AFID>100004</AFID>
                    <Name>#1 Best Affiliate, Inc.</Name>
                    <Suspended>false</Suspended>
                </Child>
            </Children>  
        </ParentRow>
    </CampaignLeadStatus>
</CampaignLeadStatusReportResult>

Example JSON Response

{
   "CampaignLeadStatus":[
      {
         "Stats":{
            "CID":100197,
            "CampaignName":"**Bret's Lead Campaign",
            "Gross":23,
            "FilteredInvalidDataField":23,
            "FilteredCampaignRules":0,
            "Filtered3rdPartyRules":0,
            "RejectedTierRules":0,
            "RejectedChannelRules":0,
            "RejectedResponse":0,
            "RejectedTotal":0,
            "ReturnedFromAll":0,
            "Sold":0
         },
         "Children":[
            {
               "AFID":100004,
               "Name":"#1 Best Affiliate, Inc.",
               "Suspended":false,
               "Gross":23,
               "FilteredInvalidDataField":23,
               "FilteredCampaignRules":0,
               "Filtered3rdPartyRules":0,
               "RejectedTierRules":0,
               "RejectedChannelRules":0,
               "RejectedResponse":0,
               "RejectedTotal":0,
               "ReturnedFromAll":0,
               "Sold":0
            },
            {
               "AFID":100014,
               "Name":"Nathan's Test Affiliate",
               "Suspended":false,
               "Gross":23,
               "FilteredInvalidDataField":0,
               "FilteredCampaignRules":5,
               "Filtered3rdPartyRules":0,
               "RejectedTierRules":1,
               "RejectedChannelRules":0,
               "RejectedResponse":8,
               "RejectedTotal":9,
               "ReturnedFromAll":0,
               "Sold":9
            }
         ]
      },
      {
         "Stats":{
            "CID":100206,
            "CampaignName":"Lead Galore",
            "Gross":28,
            "FilteredInvalidDataField":0,
            "FilteredCampaignRules":1,
            "Filtered3rdPartyRules":0,
            "RejectedTierRules":2,
            "RejectedChannelRules":0,
            "RejectedResponse":10,
            "RejectedTotal":12,
            "ReturnedFromAll":0,
            "Sold":15
         },
         "Children":[
            {
               "AFID":100004,
               "Name":"#1 Best Affiliate, Inc.",
               "Suspended":false,
               "Gross":28,
               "FilteredInvalidDataField":0,
               "FilteredCampaignRules":1,
               "Filtered3rdPartyRules":0,
               "RejectedTierRules":2,
               "RejectedChannelRules":0,
               "RejectedResponse":10,
               "RejectedTotal":12,
               "ReturnedFromAll":0,
               "Sold":15
            }
         ]
      }
   ]
}

 

 
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.