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/ |
...
167457", "@type": "Lead", " |
...
id": |
...
167457, " |
...
publisherSubId": |
...
"testSUBID", "channel": { "@id": "/api/v4/channels/ |
...
9", "@type": "Channel", "name": " |
...
Network" }, "formHash": |
...
null, "createdTs": " |
...
2024- |
...
04- |
...
19T13: |
...
43: |
...
50+ |
...
01:00", "postcode": "", "addressLine1": "", "addressLine2": "", "addressLine3": "", "addressLine4": "", "title": " |
...
",
"firstName": " |
...
Adam", "lastName": " |
...
Carter", "email": " |
...
adam@convertr.io", "telephone": "" |
...
, "dob": null, "sex": "", "photo": "", "ip": " |
...
176. |
...
25. |
...
103. |
...
77", "host": null, "optIn": |
...
true, "doubleOptIn": null, "integration": |
...
true, " |
...
overAllocation": |
...
"", " |
...
visible": |
...
true, " |
...
processrStatus": |
...
1000, " |
...
score": |
...
120, " |
...
hardfail": |
...
false, " |
...
maxScore": |
...
120, " |
...
processingCounter": |
...
1, " |
...
suppressionList": |
...
false, " |
...
imported": |
...
false, " |
...
firstDeliveredTs": " |
...
2024- |
...
04- |
...
19T13: |
...
44: |
...
00+ |
...
01:00", " |
...
emailHash": |
...
null, "fingerprint": "75a953fb28b52a0df94cb6022e779b63", |
...
"baseCurrencyPublisherPayout": "22.73", " |
...
publisherPayout": " |
...
25.00", " |
...
baseCurrencyAdvertiserPayout": " |
...
90.91", "advertiserPayout": "100.00", |
...
|
...
|
...
"publisherBillable": true, " |
...
advertiserBillable": |
...
true, |
...
|
...
"saleValue": |
...
null, " |
...
updatedTs": " |
...
2024-04-19T13:44:00+01:00", "leadData": [ |
...
{
"@id": "/api/v4/lead-datas/ |
...
2274423", "@type": "LeadData", "type": "core.data", "name": " |
...
emailDomain", "value": " |
...
@convertr.io", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274424", "@type": "LeadData", "type": "core.data", "name": " |
...
createdDate", "value": " |
...
2024-04-19", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274425", "@type": "LeadData", "type": "core.data", "name": " |
...
createdYear", "value": " |
...
2024", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274426", "@type": "LeadData", "type": "core.data", "name": " |
...
createdMonth", "value": " |
...
Apr", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274427", "@type": "LeadData", "type": "core.data", "name": " |
...
country", "value": " |
...
UK", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274428", "@type": "LeadData", "type": "core.data", "name": " |
...
job_ |
...
title", "value": " |
...
PM", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274429", "@type": "LeadData", "type": "core.data", "name": " |
...
company_ |
...
size", "value": " |
...
1 to 50", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274430", "@type": "LeadData", "type": "core.data", "name": " |
...
industry", "value": " |
...
SaaS", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274431", "@type": "LeadData", "type": "core.data", "name": "asset_ |
...
1", "value": " |
...
Dark Matter 101", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274432", "@type": "LeadData", "type": "core.data", "name": " |
...
asset_2", "value": " |
...
Why Hypnosis is a No Brainer.", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274433", "@type": "LeadData", "type": "core.data", "name": " |
...
rememberMe", "value": " |
...
1", "source": "publisher" }, { "@id": "/api/v4/lead-datas/ |
...
2274434", "@type": "LeadData", "type": "core.data", "name": "leadHash", "value": " |
...
1bd713bf4b12d39fe462655382dfca91", "source": "publisher" } |
...
, |
...
|
...
{ |
...
|
...
" |
...
@id": |
...
"/api/v4/lead-datas/2274435", " |
...
@type": " |
...
LeadData", " |
...
type": " |
...
core.data", " |
...
name": " |
...
contact", " |
...
value": "Adam |
...
Carter", " |
...
source": " |
...
Value Transform" }, |
...
{
"@id": "/api/v4/ |
...
lead-datas/ |
...
2274436", "@type": " |
...
LeadData", " |
...
type": |
...
"core.data", "name": " |
...
first_name", |
...
"value": "Adam", |
...
" |
...
source": |
...
"Value Transform" |
...
}, { |
...
|
...
" |
...
@id": |
...
"/api/v4/lead-datas/2274437", " |
...
@type": "LeadData" |
...
, |
...
...
|
...
" |
...
type": " |
...
core.data", " |
...
name": " |
...
last_name", |
...
"value": "Carter", |
...
|
...
" |
...
source": " |
...
Value Transform" }, |
...
|
...
{ |
...
|
...
" |
...
@id": " |
...
/api/v4/lead-datas/2274438", |
...
|
...
|
...
"@type": "LeadData", |
...
" |
...
type": |
...
"core.data", " |
...
name": " |
...
marketoId", " |
...
value": " |
...
6297", " |
...
source": "Marketo" }, { "@id": "/api/v4/ |
...
lead-datas/ |
...
2274439", "@type": " |
...
LeadData", " |
...
type": " |
...
core.data", |
...
"name": "marketoId", |
...
" |
...
value": |
...
"6297", |
...
|
...
"source": "Marketo Program" |
...
|
...
} |
...
], " |
...
campaingSales": |
...
[], |
...
|
...
" |
...
campaign": |
...
{ |
...
" |
...
@id": |
...
"/api/v4/campaigns/2440", " |
...
@type": " |
...
Campaign", " |
...
id": |
...
2440, "name": " |
...
Master Campaign UAT", |
...
"advertiser": |
...
{ |
...
|
...
" |
...
@id": " |
...
/api/v4/advertisers/33", |
...
|
...
|
...
"@type": "Advertiser", |
...
"id": 33, |
...
"name": " |
...
Hooli" } |
...
}, |
...
"campaignForm": null, " |
...
globalForm": { "@id": "/api/v4/ |
...
forms/8294", " |
...
@type": "Form", " |
...
id": 8294, |
...
|
...
"name": "form-8294", |
...
|
...
" |
...
slug": " |
...
form-8294" |
...
}, " |
...
publisher": { "@id": "/api/v4/ |
...
publishers/ |
...
11", "@type": " |
...
Publisher", " |
...
id": |
...
11, |
...
" |
...
name": " |
...
Massive Dynamics" }, |
...
|
...
"campaignLink": { " |
...
@id": " |
...
/api/v4/campaign-links/1940", |
...
" |
...
@type": |
...
|
...
"CampaignLink", " |
...
channel": { |
...
"@id": "/api/v4/ |
...
channels/ |
...
9", |
...
"@type": " |
...
Channel", |
...
" |
...
name": |
...
"Network" } |
...
|
...
|
...
}, |
...
"trackClick": "/api/v4/track-clicks/19512", |
...
"qaResult": { |
...
|
...
"@id": "/api/v4/lead-qa-results/1", " |
...
@type": |
...
"LeadQaResult", " |
...
name": |
...
"Valid" |
...
}, " |
...
leadFlag": null, " |
...
leadStatus": { |
...
"@id": "/api/v4/lead- |
...
statuses/ |
...
1", |
...
"@type": "LeadStatus", " |
...
name": " |
...
Valid" |
...
|
...
}, " |
...
advertiserIO": null, " |
...
integrationResults": [ |
...
{ "@id": "/api/v4/ |
...
processr-job- |
...
leads/ |
...
435792", |
...
"@type": "ProcessrJobLead", |
...
|
...
" |
...
id": |
...
435792, |
...
|
...
"passed": true, |
...
|
...
|
...
"createdTs": |
...
"2024-04-19 13:44:00", |
...
|
...
|
...
|
...
" |
...
executedTs": " |
...
2024-04-19 13:44:00", |
...
|
...
|
...
" |
...
alwaysDeliver": false |
...
|
...
} ], "whitepaper": null, "entryPoint": "form", " |
...
landingPageUrl": " |
...
https://convertr-mt1.cvtr.io/lp/master-uat", "failedJobCount": 1, "leadContactHistory": [], "leadHash": "1bd713bf4b12d39fe462655382dfca91", "leadMetadataReason": null, "firstIntegrationTs": "2024-04-19T13:44:00+01:00" } ], "hydra:totalItems": 1, "hydra:view": { "@id": "/api/v4/leads?campaign.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, |
...
campaign. |
...
advertiser. |
...
id, |
...
campaign.advertiser.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 |
...
}", "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]", |
...
"property": " |
...
advertiserPayout", " |
...
required": |
...
false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherPayout[ |
...
between]", "property": " |
...
publisherPayout", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherPayout[ |
...
gt]", "property": " |
...
publisherPayout", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherPayout[ |
...
gte]", "property": " |
...
publisherPayout", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherPayout[ |
...
lt]", "property": " |
...
publisherPayout", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherPayout[ |
...
lte]", "property": " |
...
publisherPayout", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
advertiserBillable", "property": " |
...
advertiserBillable", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisherBillable", "property": " |
...
publisherBillable", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
id", "property": " |
...
id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
id[ |
...
]",
"property": " |
...
id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
integration", "property": " |
...
integration", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
integration[ |
...
]",
"property": " |
...
integration", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
publisher.name", "property": " |
...
publisher.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaign.id", "property": " |
...
campaign.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaign.id[ |
...
]",
"property": " |
...
campaign.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaign.name", "property": " |
...
campaign.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignLink.channel.name", "property": " |
...
campaignLink.channel.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignLink.channel.name[ |
...
]",
"property": " |
...
campaignLink.channel.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
processrStatus", "property": " |
...
processrStatus", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
processrStatus[ |
...
]",
"property": " |
...
processrStatus", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
leadFlag.id", "property": " |
...
leadFlag.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
leadFlag.id[ |
...
]",
"property": " |
...
leadFlag.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
qaResult.id", "property": " |
...
qaResult.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
qaResult.id[ |
...
]",
"property": " |
...
qaResult.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": " |
...
campaignForm.id", "property": " |
...
campaignForm.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignForm.id[]", "property": " |
...
campaignForm.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignForm.name", "property": " |
...
campaignForm.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignForm. |
...
slug", "property": " |
...
campaignForm. |
...
slug", "required": false }, { "@type": "IriTemplateMapping", "variable": "campaign.advertiser.id |
...
", "property": "campaign.advertiser.id", "required": false }, { "@type": "IriTemplateMapping", "variable": "campaign.advertiser. |
...
id[]", "property": "campaign.advertiser. |
...
id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaign. |
...
advertiser.name", "property": " |
...
campaign. |
...
advertiser.name", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
postcode", "property": " |
...
postcode", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
addressLine1", "property": " |
...
addressLine1", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
addressLine2", "property": " |
...
addressLine2", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
addressLine3", "property": " |
...
addressLine3", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
addressLine4", "property": " |
...
addressLine4", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
title", "property": " |
...
title", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
firstName", "property": " |
...
firstName", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
lastName", "property": " |
...
lastName", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
telephone", "property": " |
...
telephone", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
sex", "property": " |
...
sex", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
photo", "property": " |
...
photo", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
leadContactHistoryCurrentStatus", "property": " |
...
leadContactHistoryCurrentStatus", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
leadContactHistoryCallNumber", "property": " |
...
leadContactHistoryCallNumber", "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": " |
...
leadDataName[]", "property": " |
...
leadDataName[]", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignProcessrJobsPassed", "property": " |
...
campaignProcessrJobsPassed[]", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
processrJobsPassed", "property": " |
...
processrJobsPassed[]", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
campaignProcessrJobsFailed", "property": " |
...
campaignProcessrJobsFailed[]", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
processrJobsFailed", "property": " |
...
processrJobsFailed[]", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
firstDeliveredTs[before]", "property": " |
...
firstDeliveredTs", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
firstDeliveredTs[strictly_before]", "property": " |
...
firstDeliveredTs", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
firstDeliveredTs[after]", "property": " |
...
firstDeliveredTs", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
firstDeliveredTs[strictly_after]", "property": " |
...
firstDeliveredTs", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
currentLeadFlagHistory.leadFlagReason.id", "property": " |
...
currentLeadFlagHistory.leadFlagReason.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
currentLeadFlagHistory.leadFlagReason.id[]", "property": " |
...
currentLeadFlagHistory.leadFlagReason.id", "required": false }, { "@type": "IriTemplateMapping", "variable": " |
...
email", "property": " |
...
email", "required": false } ] } } |