Request
...
Scope
This Leads API outputs the lead's details, lead status, associated campaign information, integration results, and any other additional metadata.
When requesting the date adjustments can be made in the request based on specific filters.
Request
...
campaign.id={campaign |
...
id} |
...
&createdTs[after]={yyyy-mm-dd} |
...
&createdTs[before]={yyyy-mm-dd} |
...
&page={page |
...
number} |
Example Response
| Code Block |
|---|
{
"@context": "/api/v4/contexts/Lead",
"@id": "/api/v4/leads",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/leads/63494167457",
"@type": "Lead",
"landingPageUrlid": null167457,
"idpublisherSubId": 63494, "publisherSubId": null"testSUBID",
"channel": {
"@id": "/api/v4/channels/299",
"@type": "Channel",
"name": "YouTubeNetwork"
},
"formHash": "168"null,
"createdTs": "20202024-0204-25T2319T13:2543:1650+0001:00",
"postcode": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"title": "test ",
"firstName": "test Adam",
"lastName": "test Carter",
"email": "test adam@convertr.io",
"telephone": "(+1) 45656456234",
"dob": null,
"sex": "",
"photo": "",
"ip": "172176.1725.0103.1577",
"host": null,
"optIn": falsetrue,
"doubleOptIn": null,
"integration": falsetrue,
"visibleoverAllocation": true"",
"processrStatusvisible": 1000true,
"scoreprocessrStatus": 1501000,
"hardfailscore": true120,
"maxScorehardfail": 320false,
"processingCountermaxScore": 1120,
"suppressionListprocessingCounter": false1,
"emailHashsuppressionList": nullfalse,
"fingerprintimported": nullfalse,
"updatedTsfirstDeliveredTs": "20202024-0204-25T2319T13:2544:2300+0001:00",
"leadDataemailHash": null,
[ "fingerprint": "75a953fb28b52a0df94cb6022e779b63",
{ "baseCurrencyPublisherPayout": "22.73",
"@idpublisherPayout": "/api/v4/lead-datas/192793825.00",
"@type"baseCurrencyAdvertiserPayout": "LeadData90.91",
"typeadvertiserPayout": "core100.data00",
"publisherBillable": true,
"name": "emailDomain", "advertiserBillable": true,
"valuesaleValue": "test",
null,
"sourceupdatedTs": "publisher"2024-04-19T13:44:00+01:00",
},"leadData": [
{
"@id": "/api/v4/lead-datas/19279392274423",
"@type": "LeadData",
"type": "core.data",
"name": "createdDateemailDomain",
"value": "2020-02-25@convertr.io",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279402274424",
"@type": "LeadData",
"type": "core.data",
"name": "companycreatedDate",
"value": "test2024-04-19",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279412274425",
"@type": "LeadData",
"type": "core.data",
"name": "industrycreatedYear",
"value": "test2024",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279422274426",
"@type": "LeadData",
"type": "core.data",
"name": "addresscreatedMonth",
"value": "testApr",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279432274427",
"@type": "LeadData",
"type": "core.data",
"name": "citycountry",
"value": "testUK",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279442274428",
"@type": "LeadData",
"type": "core.data",
"name": "usjob_statetitle",
"value": "testPM",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279452274429",
"@type": "LeadData",
"type": "core.data",
"name": "postalcompany_codesize",
"value": "test1 to 50",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279462274430",
"@type": "LeadData",
"type": "core.data",
"name": "countryindustry",
"value": "testSaaS",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279472274431",
"@type": "LeadData",
"type": "core.data",
"name": "asset_downloaded1",
"value": "testDark Matter 101",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279482274432",
"@type": "LeadData",
"type": "core.data",
"name": "campaignasset_2",
"value": "testWhy Hypnosis is a No Brainer.",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279492274433",
"@type": "LeadData",
"type": "core.data",
"name": "rep_namerememberMe",
"value": "test1",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/19279502274434",
"@type": "LeadData",
"type": "core.data",
"name": "leadHash",
"value": "5885fd9e9bcb6bd1071e28ba7c9b44861bd713bf4b12d39fe462655382dfca91",
"source": "publisher"
}
],
"campaingSales": [], {
"campaign": { "@id": "/api/v4/campaignslead-datas/440892274435",
"@type": "CampaignLeadData",
"statustype": "activecore.data",
"idname": 44089,"contact",
"namevalue": "Adam Carter"B2B,
Publisher training Demo", "advertisersource": "Value {Transform"
},
" {
"@id": "/api/v4/advertiserslead-datas/220702274436",
"@type": "AdvertiserLeadData",
"idtype": 22070"core.data",
"name": "B2B Adv"first_name",
} "value": "Adam",
}, "campaignFormsource": {"Value Transform"
"@id": "/api/v4/campaign-forms/168", },
{
"@type": "CampaignForm", "id@id": 168,"/api/v4/lead-datas/2274437",
"name@type": "I B2B Demo 2",LeadData",
"slugtype": "i-b2b-demo-2core.data",
"linkname": "https://demo.cvtr.io/forms/i-b2b-demo-2"last_name",
}, "value": "Carter",
"publisher": { "@idsource": "/api/v4/publishers/11033",Value Transform"
"@type": "Publisher",},
{
"id": 11033, "name@id": "Convertr Test Publisher","/api/v4/lead-datas/2274438",
"publisherRating@type": 22"LeadData",
}, "type": "core.data",
"campaignLink": { "name": "marketoId",
"@idvalue": "/api/v4/campaign-links/3046297",
"@typesource": "CampaignLink",
Marketo"
},
"channel": {
"@id": "/api/v4/channelslead-datas/292274439",
"@type": "ChannelLeadData",
"nametype": "YouTubecore.data",
} "name": "marketoId",
}, "trackClickvalue": null,"6297",
"leadFlagsource": null, "Marketo Program"
"qaResult }
],
"campaingSales": [],
"campaign": {
"@id": "/api/v4/lead-qa-results/2campaigns/2440",
"@type": "LeadQaResultCampaign",
"nameid": "Invalid"2440,
},"name": "Master Campaign UAT",
"leadStatusadvertiser": {
"@id": "/api/v4/lead-statusesadvertisers/233",
"@type": "LeadStatusAdvertiser",
"name": "Invalid" "id": 33,
}, "publisherPayoutname": "0.00Hooli",
"advertiserPayout": "0.00", }
"leadProcessrJobs": [ },
"/api/v4/processr-job-leads/589050"campaignForm": null,
"globalForm": {
"/api/v4/processr-job-leads/589051", "@id": "/api/v4/processr-job-leads/589052forms/8294",
"@type": "/api/v4/processr-job-leads/589053Form",
"/api/v4/processr-job-leads/589054",id": 8294,
"name": "/api/v4/processr-job-leads/589055form-8294",
"/api/v4/processr-job-leads/589056","slug": "form-8294"
},
"/api/v4/processr-job-leads/589057",publisher": {
"@id": "/api/v4/processr-job-leads/589058"publishers/11",
],"@type": "Publisher",
"trackConversionid": []11,
"processrNodename": "leadProcessingService::processingComplete",Massive Dynamics"
"overAllocation": false},
"campaignPublishercampaignLink": {
"@id": "/api/v4/campaign-publisherslinks/2551940",
"@type": "CampaignPublisherCampaignLink",
"campaignchannel": {
"@id": "/api/v4/campaignschannels/440899",
"@type": "CampaignChannel",
"statusname": "activeNetwork",
}
"id": 44089, },
"nametrackClick": "B2B Publisher training Demo",
/api/v4/track-clicks/19512",
"advertiserqaResult": {
"@id": "/api/v4/advertisers/22070",lead-qa-results/1",
"@type": "LeadQaResult",
"@typename": "AdvertiserValid",
},
"idleadFlag": 22070null,
"leadStatus": {
"name@id": "B2B Adv"/api/v4/lead-statuses/1",
"@type": "LeadStatus",
} }"name": "Valid"
},
"leadFlagHistoryadvertiserIO": []null,
"saleValueintegrationResults": null,[
"imported": true, {
"advertiserIO": null, "leadInvalidB2b@id": [
"/api/v4/leadprocessr-invalidjob-b2bsleads/942"
435792",
], "baseCurrencyPublisherPayout@type": "0.00ProcessrJobLead",
"baseCurrencyAdvertiserPayoutid": "0.00"435792,
"whitepaper": null, "passed": true,
"leadNotes": [ "createdTs": "/api/v4/lead-notes/1187502024-04-19 13:44:00",
"/api/v4/lead-notes/118751" "executedTs": "2024-04-19 13:44:00",
], "campaignEventLogalwaysDeliver": false
[], "campaignPublisherBand": null, }
"campaignPayoutBand": null ],
"entryPointwhitepaper": "import"
null,
} ], "hydra:totalItemsentryPoint": 1"form",
"hydra:view": { "@idlandingPageUrl": "/api/v4/leads?createdTs%5Bbefore%5D=2020-02-26&createdTs%5Bafter%5D=2020-02-25",
https://convertr-mt1.cvtr.io/lp/master-uat",
"@type": "hydra:PartialCollectionView" "failedJobCount": }1,
"hydra:search": { "leadContactHistory": [],
"@type "leadHash": "1bd713bf4b12d39fe462655382dfca91",
"leadMetadataReason": null,
"firstIntegrationTs": "hydra:IriTemplate"2024-04-19T13:44:00+01:00"
}
],
"hydra:totalItems": 1,
"hydra:template:view": {
"@id": "/api/v4/leads{?order[id],createdTscampaign.id=2440&id=167457",
"@type": "hydra:PartialCollectionView"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/leads{?order[id],createdTs[before],createdTs[strictly_before],createdTs[after],createdTs[strictly_after],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],order[id],order[channel.id],order[score],order[advertiserPayout],order[email],leadFlag[exists],publisher[exists],advertiserPayout[between],advertiserPayout[gt],advertiserPayout[gte],advertiserPayout[lt],advertiserPayout[lte],publisherPayout[between],publisherPayout[gt],publisherPayout[gte],publisherPayout[lt],publisherPayout[lte],advertiserBillable,publisherBillable,id,id[],integration,integration[],publisher.name,campaign.id,campaign.id[],campaign.name,campaignLink.channel.name,campaignLink.channel.name[],processrStatus,processrStatus[],leadFlag.id,leadFlag.id[],qaResult.id,qaResult.id[],leadStatus.id,leadStatus.id[],campaignForm.id,campaignForm.id[],campaignForm.name,campaignForm.slug,leadDatacampaign.name,leadDataadvertiser.typeid,leadDatacampaign.source,leadData.depth,leadData.valueadvertiser.id[],campaign.advertiser.name,postcode,addressLine1,addressLine2,addressLine3,addressLine4,title,firstName,lastName,telephone,sex,photo,leadContactHistoryCurrentStatus,leadContactHistoryCallNumber,leadData.name,leadData.type,leadData.source,leadData.depth,leadData.value,leadDataName[],campaignProcessrJobsPassed,processrJobsPassed,campaignProcessrJobsFailed,processrJobsFailed,firstDeliveredTs[before],firstDeliveredTs[strictly_before],firstDeliveredTs[after],firstDeliveredTs[strictly_after],currentLeadFlagHistory.leadFlagReason.id,currentLeadFlagHistory.leadFlagReason.id[],email,telephone,sex,photo}}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_before]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTs[strictly_after]",
"property": "createdTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_before]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_after]",
"property": "updatedTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[channel.id]",
"property": "channel.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[score]",
"property": "score",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[advertiserPayout]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[email]",
"property": "email",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadFlag[exists]",
"property": "leadFlag",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisher[exists]",
"property": "publisher",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[between]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gt]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gte]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[lt]",
"property": "advertiserPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[lte]",
"hydra:variableRepresentation "property": "BasicRepresentationadvertiserPayout",
"hydra:mappingrequired": [ false
},
{
"@type": "IriTemplateMapping",
"variable": "orderpublisherPayout[idbetween]",
"property": "idpublisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTspublisherPayout[beforegt]",
"property": "createdTspublisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTspublisherPayout[strictly_beforegte]",
"property": "createdTspublisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTspublisherPayout[afterlt]",
"property": "createdTspublisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "createdTspublisherPayout[strictly_afterlte]",
"property": "createdTspublisherPayout",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[before]advertiserBillable",
"property": "updatedTsadvertiserBillable",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[strictly_before]publisherBillable",
"property": "updatedTspublisherBillable",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTs[after]id",
"property": "updatedTsid",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "updatedTsid[strictly_after]",
"property": "updatedTsid",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]integration",
"property": "idintegration",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "orderintegration[channel.id]",
"property": "channel.idintegration",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[score]publisher.name",
"property": "scorepublisher.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[advertiserPayout]campaign.id",
"property": "advertiserPayoutcampaign.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayoutcampaign.id[between]",
"property": "advertiserPayoutcampaign.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gt]campaign.name",
"property": "advertiserPayoutcampaign.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[gte]campaignLink.channel.name",
"property": "advertiserPayoutcampaignLink.channel.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayoutcampaignLink.channel.name[lt]",
"property": "advertiserPayoutcampaignLink.channel.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiserPayout[lte]processrStatus",
"property": "advertiserPayoutprocessrStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayoutprocessrStatus[between]",
"property": "publisherPayoutprocessrStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[gt]leadFlag.id",
"property": "publisherPayoutleadFlag.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayoutleadFlag.id[gte]",
"property": "publisherPayoutleadFlag.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayout[lt]qaResult.id",
"property": "publisherPayoutqaResult.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherPayoutqaResult.id[lte]",
"property": "publisherPayoutqaResult.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.id",
"property": "leadStatus.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.id[]",
"property": "leadStatus.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "integrationcampaignForm.id",
"property": "integrationcampaignForm.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "integrationcampaignForm.id[]",
"property": "integrationcampaignForm.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publishercampaignForm.name",
"property": "publishercampaignForm.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaigncampaignForm.idslug",
"property": "campaigncampaignForm.idslug",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.advertiser.id[]",
"property": "campaign.advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.advertiser.nameid[]",
"property": "campaign.advertiser.nameid",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignLinkcampaign.channeladvertiser.name",
"property": "campaignLinkcampaign.channeladvertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignLink.channel.name[]postcode",
"property": "campaignLink.channel.namepostcode",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrStatusaddressLine1",
"property": "processrStatusaddressLine1",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrStatus[]addressLine2",
"property": "processrStatusaddressLine2",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadFlag.idaddressLine3",
"property": "leadFlag.idaddressLine3",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadFlag.id[]addressLine4",
"property": "leadFlag.idaddressLine4",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "qaResult.idtitle",
"property": "qaResult.idtitle",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "qaResult.id[]firstName",
"property": "qaResult.idfirstName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.idlastName",
"property": "leadStatus.idlastName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadStatus.id[]telephone",
"property": "leadStatus.idtelephone",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.idsex",
"property": "campaignForm.idsex",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.id[]photo",
"property": "campaignForm.idphoto",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.nameleadContactHistoryCurrentStatus",
"property": "campaignForm.nameleadContactHistoryCurrentStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignForm.slugleadContactHistoryCallNumber",
"property": "campaignForm.slugleadContactHistoryCallNumber",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.name",
"property": "leadData.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.type",
"property": "leadData.type",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.source",
"property": "leadData.source",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.depth",
"property": "leadData.depth",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "leadData.value",
"property": "leadData.value",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "postcodeleadDataName[]",
"property": "postcodeleadDataName[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine1campaignProcessrJobsPassed",
"property": "addressLine1campaignProcessrJobsPassed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine2processrJobsPassed",
"property": "addressLine2processrJobsPassed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine3campaignProcessrJobsFailed",
"property": "addressLine3campaignProcessrJobsFailed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "addressLine4processrJobsFailed",
"property": "addressLine4processrJobsFailed[]",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "titlefirstDeliveredTs[before]",
"property": "titlefirstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "firstNamefirstDeliveredTs[strictly_before]",
"property": "firstNamefirstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "lastNamefirstDeliveredTs[after]",
"property": "lastNamefirstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "emailfirstDeliveredTs[strictly_after]",
"property": "emailfirstDeliveredTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "telephonecurrentLeadFlagHistory.leadFlagReason.id",
"property": "telephonecurrentLeadFlagHistory.leadFlagReason.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "sexcurrentLeadFlagHistory.leadFlagReason.id[]",
"property": "sexcurrentLeadFlagHistory.leadFlagReason.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "photoemail",
"property": "photoemail",
"required": false
}
]
}
} |
...