Request
https://{enterprise}.cvtr.io/api/v4/leads?
campaign.id={campaign id}
&createdTs[after]={yyyy-mm-dd}
&createdTs[before]={yyyy-mm-dd}
&page={page number}
Response
{
"@context": "/api/v4/contexts/Lead",
"@id": "/api/v4/leads",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/leads/63494",
"@type": "Lead",
"landingPageUrl": null,
"id": 63494,
"publisherSubId": null,
"channel": {
"@id": "/api/v4/channels/29",
"@type": "Channel",
"name": "YouTube"
},
"formHash": "168",
"createdTs": "2020-02-25T23:25:16+00:00",
"postcode": "",
"addressLine1": "",
"addressLine2": "",
"addressLine3": "",
"addressLine4": "",
"title": "test ",
"firstName": "test ",
"lastName": "test ",
"email": "test ",
"telephone": "(+1) 45656456234",
"dob": null,
"sex": "",
"photo": "",
"ip": "172.17.0.15",
"host": null,
"optIn": false,
"doubleOptIn": null,
"integration": false,
"visible": true,
"processrStatus": 1000,
"score": 150,
"hardfail": true,
"maxScore": 320,
"processingCounter": 1,
"suppressionList": false,
"emailHash": null,
"fingerprint": null,
"updatedTs": "2020-02-25T23:25:23+00:00",
"leadData": [
{
"@id": "/api/v4/lead-datas/1927938",
"@type": "LeadData",
"type": "core.data",
"name": "emailDomain",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927939",
"@type": "LeadData",
"type": "core.data",
"name": "createdDate",
"value": "2020-02-25",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927940",
"@type": "LeadData",
"type": "core.data",
"name": "company",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927941",
"@type": "LeadData",
"type": "core.data",
"name": "industry",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927942",
"@type": "LeadData",
"type": "core.data",
"name": "address",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927943",
"@type": "LeadData",
"type": "core.data",
"name": "city",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927944",
"@type": "LeadData",
"type": "core.data",
"name": "us_state",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927945",
"@type": "LeadData",
"type": "core.data",
"name": "postal_code",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927946",
"@type": "LeadData",
"type": "core.data",
"name": "country",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927947",
"@type": "LeadData",
"type": "core.data",
"name": "asset_downloaded",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927948",
"@type": "LeadData",
"type": "core.data",
"name": "campaign",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927949",
"@type": "LeadData",
"type": "core.data",
"name": "rep_name",
"value": "test",
"source": "publisher"
},
{
"@id": "/api/v4/lead-datas/1927950",
"@type": "LeadData",
"type": "core.data",
"name": "leadHash",
"value": "5885fd9e9bcb6bd1071e28ba7c9b4486",
"source": "publisher"
}
],
"campaingSales": [],
"campaign": {
"@id": "/api/v4/campaigns/44089",
"@type": "Campaign",
"status": "active",
"id": 44089,
"name": "B2B Publisher training Demo",
"advertiser": {
"@id": "/api/v4/advertisers/22070",
"@type": "Advertiser",
"id": 22070,
"name": "B2B Adv"
}
},
"campaignForm": {
"@id": "/api/v4/campaign-forms/168",
"@type": "CampaignForm",
"id": 168,
"name": "I B2B Demo 2",
"slug": "i-b2b-demo-2",
"link": "https://demo.cvtr.io/forms/i-b2b-demo-2"
},
"publisher": {
"@id": "/api/v4/publishers/11033",
"@type": "Publisher",
"id": 11033,
"name": "Convertr Test Publisher",
"publisherRating": 22
},
"campaignLink": {
"@id": "/api/v4/campaign-links/304",
"@type": "CampaignLink",
"channel": {
"@id": "/api/v4/channels/29",
"@type": "Channel",
"name": "YouTube"
}
},
"trackClick": null,
"leadFlag": null,
"qaResult": {
"@id": "/api/v4/lead-qa-results/2",
"@type": "LeadQaResult",
"name": "Invalid"
},
"leadStatus": {
"@id": "/api/v4/lead-statuses/2",
"@type": "LeadStatus",
"name": "Invalid"
},
"publisherPayout": "0.00",
"advertiserPayout": "0.00",
"leadProcessrJobs": [
"/api/v4/processr-job-leads/589050",
"/api/v4/processr-job-leads/589051",
"/api/v4/processr-job-leads/589052",
"/api/v4/processr-job-leads/589053",
"/api/v4/processr-job-leads/589054",
"/api/v4/processr-job-leads/589055",
"/api/v4/processr-job-leads/589056",
"/api/v4/processr-job-leads/589057",
"/api/v4/processr-job-leads/589058"
],
"trackConversion": [],
"processrNode": "leadProcessingService::processingComplete",
"overAllocation": false,
"campaignPublisher": {
"@id": "/api/v4/campaign-publishers/255",
"@type": "CampaignPublisher",
"campaign": {
"@id": "/api/v4/campaigns/44089",
"@type": "Campaign",
"status": "active",
"id": 44089,
"name": "B2B Publisher training Demo",
"advertiser": {
"@id": "/api/v4/advertisers/22070",
"@type": "Advertiser",
"id": 22070,
"name": "B2B Adv"
}
}
},
"leadFlagHistory": [],
"saleValue": null,
"imported": true,
"advertiserIO": null,
"leadInvalidB2b": [
"/api/v4/lead-invalid-b2bs/942"
],
"baseCurrencyPublisherPayout": "0.00",
"baseCurrencyAdvertiserPayout": "0.00",
"whitepaper": null,
"leadNotes": [
"/api/v4/lead-notes/118750",
"/api/v4/lead-notes/118751"
],
"campaignEventLog": [],
"campaignPublisherBand": null,
"campaignPayoutBand": null,
"entryPoint": "import"
}
],
"hydra:totalItems": 1,
"hydra:view": {
"@id": "/api/v4/leads?createdTs%5Bbefore%5D=2020-02-26&createdTs%5Bafter%5D=2020-02-25",
"@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],advertiserPayout[between],advertiserPayout[gt],advertiserPayout[gte],advertiserPayout[lt],advertiserPayout[lte],publisherPayout[between],publisherPayout[gt],publisherPayout[gte],publisherPayout[lt],publisherPayout[lte],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,leadData.name,leadData.type,leadData.source,leadData.depth,leadData.value,postcode,addressLine1,addressLine2,addressLine3,addressLine4,title,firstName,lastName,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": "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": "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": "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": "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": "email",
"property": "email",
"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
}
]
}
}