Affiliate Lead Status API

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

Base URL 

/v2/Reports/AffiliateLeadStatus

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/AffiliateLeadStatus?StartDate=10/09/2013&EndDate=10/09/2013&TrafficFilterLeadStats=1

Example XML Response

<AffiliateLeadStatusReportResult>
    <AffiliateLeadStatus>
        <ParentRow>
            <Stats>
                <Filtered3rdPartyRules>195</Filtered3rdPartyRules>
                <FilteredCampaignRules>166</FilteredCampaignRules>
                <FilteredInvalidDataField>223</FilteredInvalidDataField>
                <Gross>7869</Gross>
                <RejectedChannelRules>186</RejectedChannelRules>
                <RejectedResponse>907</RejectedResponse>
                <RejectedTierRules>276</RejectedTierRules>
                <RejectedTotal>1369</RejectedTotal>
                <ReturnedFromAll>911</ReturnedFromAll>
                <Sold>5005</Sold>
                <AFID>100004</AFID>
                <AffiliateName>#1 Best Affiliate, Inc.</AffiliateName>
                <Suspended>false</Suspended>
            </Stats>
        <Children>
            <Child>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>0</FilteredCampaignRules>
                <FilteredInvalidDataField>0</FilteredInvalidDataField>
                <Gross>2</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>0</RejectedResponse>
                <RejectedTierRules>0</RejectedTierRules>
                <RejectedTotal>0</RejectedTotal>
                <ReturnedFromAll>1</ReturnedFromAll>
                <Sold>1</Sold>
                <CID>100214</CID>
                <CampaignName>**Lead Gen Test </CampaignName>
            </Child>
            <Child>
                <Filtered3rdPartyRules>4</Filtered3rdPartyRules>
                <FilteredCampaignRules>3</FilteredCampaignRules>
                <FilteredInvalidDataField>3</FilteredInvalidDataField>
                <Gross>29</Gross>
                <RejectedChannelRules>3</RejectedChannelRules>
                <RejectedResponse>3</RejectedResponse>
                <RejectedTierRules>3</RejectedTierRules>
                <RejectedTotal>9</RejectedTotal>
                <ReturnedFromAll>3</ReturnedFromAll>
                <Sold>7</Sold>
                <CID>100205</CID>
                <CampaignName>Gman Leads</CampaignName>
            </Child>
            <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>
                <CID>100206</CID>
                <CampaignName>Lead Galore</CampaignName>
            </Child>
        </Children>
    </ParentRow>
    <ParentRow>
        <Stats>
            <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
            <FilteredCampaignRules>0</FilteredCampaignRules>
            <FilteredInvalidDataField>13</FilteredInvalidDataField>
            <Gross>15</Gross>
            <RejectedChannelRules>0</RejectedChannelRules>
            <RejectedResponse>0</RejectedResponse>
            <RejectedTierRules>0</RejectedTierRules>
            <RejectedTotal>0</RejectedTotal>
            <ReturnedFromAll>0</ReturnedFromAll>
            <Sold>2</Sold>
            <AFID>100314</AFID>
            <AffiliateName>Gman</AffiliateName>
            <Suspended>false</Suspended>
        </Stats>
        <Children>
            <Child>
                <Filtered3rdPartyRules>0</Filtered3rdPartyRules>
                <FilteredCampaignRules>0</FilteredCampaignRules>
                <FilteredInvalidDataField>13</FilteredInvalidDataField>
                <Gross>15</Gross>
                <RejectedChannelRules>0</RejectedChannelRules>
                <RejectedResponse>0</RejectedResponse>
                <RejectedTierRules>0</RejectedTierRules>
                <RejectedTotal>0</RejectedTotal>
                <ReturnedFromAll>0</ReturnedFromAll>
                <Sold>2</Sold>
                <CID>100199</CID>
                <CampaignName>Bryan's Lead Gen Test</CampaignName>
            </Child>
        </Children>
        </ParentRow>
    </AffiliateLeadStatus>
</AffiliateLeadStatusReportResult>

Example JSON Response

{
"AffiliateLeadStatus":[
      {
         "Stats":{
            "AFID":100004,
            "AffiliateName":"#1 Best Affiliate, Inc.",
            "Gross":7869,
            "FilteredInvalidDataField":223,
            "FilteredCampaignRules":166,
            "Filtered3rdPartyRules":195,
            "RejectedTierRules":276,
            "RejectedChannelRules":186,
            "RejectedResponse":907,
            "RejectedTotal":1369,
            "ReturnedFromAll":911,
            "Sold":5005,
            "Suspended":false
         },
         "Children":[
            {
               "CID":100214,
               "CampaignName":"**Lead Gen Test  ",
               "Gross":2,
               "FilteredInvalidDataField":0,
               "FilteredCampaignRules":0,
               "Filtered3rdPartyRules":0,
               "RejectedTierRules":0,
               "RejectedChannelRules":0,
               "RejectedResponse":0,
               "RejectedTotal":0,
               "ReturnedFromAll":1,
               "Sold":1
            },
            {
               "CID":100205,
               "CampaignName":"Gman Leads",
               "Gross":29,
               "FilteredInvalidDataField":3,
               "FilteredCampaignRules":3,
               "Filtered3rdPartyRules":4,
               "RejectedTierRules":3,
               "RejectedChannelRules":3,
               "RejectedResponse":3,
               "RejectedTotal":9,
               "ReturnedFromAll":3,
               "Sold":7
            },
            {
               "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
            }
         ]
      },
      {
         "Stats":{
            "AFID":100314,
            "AffiliateName":"Gman",
            "Gross":15,
            "FilteredInvalidDataField":13,
            "FilteredCampaignRules":0,
            "Filtered3rdPartyRules":0,
            "RejectedTierRules":0,
            "RejectedChannelRules":0,
            "RejectedResponse":0,
            "RejectedTotal":0,
            "ReturnedFromAll":0,
            "Sold":2,
            "Suspended":false
         },
         "Children":[
            {
               "CID":100199,
               "CampaignName":"Bryan's Lead Gen Test",
               "Gross":15,
               "FilteredInvalidDataField":13,
               "FilteredCampaignRules":0,
               "Filtered3rdPartyRules":0,
               "RejectedTierRules":0,
               "RejectedChannelRules":0,
               "RejectedResponse":0,
               "RejectedTotal":0,
               "ReturnedFromAll":0,
               "Sold":2
            }
         ]
      }
   ]
}
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.