| Table of Contents |
|---|
Authenticating
Please see: API v4.0.0 - API Login this also details resetting your password over the API API v4.0.0 - Reset User Password
Lead Data
Once you've requested an access token, you'll be able to start making calls to the API.
...
You can also request more items per page by passing the ?itemsPerPage=x property in your request. The maximum number of results per page is 100.
Campaigns
Retrieving a list of campaigns:
...
Example response:
| Code Block | ||
|---|---|---|
| ||
{
"@context": "/api/v4/contexts/Campaign",
"@id": "/api/v4/campaigns",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/campaigns/601",
"@type": "Campaign",
"status": "Active",
"id": 601,
"name": "Test Campaign",
"startTs": "2021-08-31T23:00:00+00:00",
"endTs": "2021-11-30T23:59:59+00:00",
"exposePublisher": false,
"exposePublisherSub": false,
"updatedTs": "2021-09-01T09:55:06+00:00",
"defaultThresholdScore": 70,
"integrate": true,
"callCentre": false,
"welcomeEmail": false,
"doubleOptin": false,
"scoreBaseRouting": false,
"defaultSaleValue": "0.01",
"defaultSaleCurrency": "GBP",
"advertiser": {
"@id": "/api/v4/advertisers/319",
"@type": "Advertiser",
"id": 319,
"name": "deployment 2021-09-01"
},
"accountManager": null,
"subcategory": {
"@id": "/api/v4/subcategories/1",
"@type": "Subcategory",
"id": 1,
"name": "Marketing"
},
"country": null,
"campaignMarket": "b2b",
"contractValue": "1000.00",
"performanceModel": "full",
"internalOnly": false,
"defaultPublisherRate": 55,
"publisherPayoutType": "CPL",
"manualScore": false,
"combinedJobScore": 140,
"useValueTransforms": true,
"campaignManager": null,
"pauseTs": null,
"publisherTerms": null,
"sendVoucher": false,
"testMode": false,
"sendMediakit": true,
"conversionRate": "1.0000",
"currency": {
"@id": "/api/v4/currencies/1",
"@type": "Currency",
"id": 1,
"name": "GBP",
"symbol": "£",
"base": true,
"rateToBase": "1.0000"
},
"baseCurrencyContractValue": "1000.00",
"endTsExtension": 0,
"unavailableCampaignLogic": "allow_leads",
"unavailableCampaignRedirectUrl": null,
"holdPublisherOverDelivery": false,
"valueBasedRouting": false,
"autoSignPublisher": false,
"variablePublisherPayout": false,
"useScheduledDelivery": false,
"uncapped": false,
"facebookOfflineEventSetId": null,
"facebookSystemUserAccessToken": null,
"leadProcessDelay": 0,
"apiKey": "0c463164f0d4fcb604d8fd9f80737476",
"leadsRequired": 100,
"payoutAmount": "10.00",
"payout": "CPL",
"baseCurrencyPayoutAmount": "10.00",
"notes": null,
"signName": "Rokas Bartkevicius",
"signRole": "super dev",
"signTs": "2021-09-01T09:52:56+00:00",
"signIoNumber": "7541",
"terms": "",
"statistics": {
"totalLeads": 4,
"invalidLeads": 1,
"cautionLeads": 1,
"validLeads": 3,
"billableLeads": 3,
"deliveredLeads": 3,
"heldLeads": 0,
"processingLeads": 0,
"impressions": 0,
"conversions": 2,
"lastConversion": "2021-09-01T10:56:35+01:00",
"clicks": 2,
"activePublishers": 1,
"totalSales": 0,
"campaignRevenue": {
"revenue": "30.00",
"baseCurrencyRevenue": "30.00",
"publisherPayout": "16.50",
"baseCurrencyPublisherPayout": "16.50"
},
"unsignedContracts": 0
},
"signHash": "6640a031859455338d516f3ec6019efc",
"allowPublisherImportExport": true,
"purchaseOrder": null,
"referenceNumber": null,
"purchaseOrderFile": null
}
],
"hydra:totalItems": 479,
"hydra:view": {
"@id": "/api/v4/campaigns?itemsPerPage=1&page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/campaigns?itemsPerPage=1&page=1",
"hydra:last": "/api/v4/campaigns?itemsPerPage=1&page=479",
"hydra:next": "/api/v4/campaigns?itemsPerPage=1&page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/campaigns{?id,id[],name,order[id],order[name],createdTs[before],createdTs[strictly_before],createdTs[after],createdTs[strictly_after],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],startTs[before],startTs[strictly_before],startTs[after],startTs[strictly_after],endTs[before],endTs[strictly_before],endTs[after],endTs[strictly_after],order[statistics.invalidLeads],order[statistics.validLeads],order[statistics.cautionLeads],order[statistics.heldLeads],order[statistics.processingLeads],order[statistics.billableLeads],order[statistics.impressions],order[statistics.conversions],order[statistics.clicks],status[],order[advertiser.name],order[startTs],order[endTs],order[country.id],order[country.iso],order[statistics.activePublishers],order[statistics.totalSales],order[statistics.campaignRevenue.revenue],order[statistics.campaignRevenue.baseCurrencyRevenue],idName,campaignProcessrJobs.processrJob.id,campaignProcessrJobs.processrJob.id[],campaignPublishers.publisher.id,campaignPublishers.publisher.id[],advertiser.id,advertiser.id[],advertiser.name,campaignManager,accountManager,country.id,country.id[],country.iso,country.iso[]}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "name",
"property": "name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[id]",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[name]",
"property": "name",
"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": "startTs[before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.invalidLeads]",
"property": "statistics.invalidLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.validLeads]",
"property": "statistics.validLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.cautionLeads]",
"property": "statistics.cautionLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.heldLeads]",
"property": "statistics.heldLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.processingLeads]",
"property": "statistics.processingLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.billableLeads]",
"property": "statistics.billableLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.impressions]",
"property": "query",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.conversions]",
"property": "statistics.conversions",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.clicks]",
"property": "statistics.clicks",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "status[]",
"property": "status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[advertiser.name]",
"property": "advertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[startTs]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[endTs]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[country.id]",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[country.iso]",
"property": "country.iso",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.activePublishers]",
"property": "statistics.activePublishers",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.totalSales]",
"property": "statistics.totalSales",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.campaignRevenue.revenue]",
"property": "statistics.campaignRevenue.revenue",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.campaignRevenue.baseCurrencyRevenue]",
"property": "statistics.campaignRevenue.baseCurrencyRevenue",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "idName",
"property": "idName",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.processrJob.id",
"property": "campaignProcessrJobs.processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignProcessrJobs.processrJob.id[]",
"property": "campaignProcessrJobs.processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignPublishers.publisher.id",
"property": "campaignPublishers.publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignPublishers.publisher.id[]",
"property": "campaignPublishers.publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.id",
"property": "advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.id[]",
"property": "advertiser.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "advertiser.name",
"property": "advertiser.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaignManager",
"property": "campaignManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "accountManager",
"property": "accountManager",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.id",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.id[]",
"property": "country.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.iso",
"property": "country.iso",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "country.iso[]",
"property": "country.iso",
"required": false
}
]
}
} |
Campaign > Publishers
This section is very complex. Some prerequisites:
Publishers can have multiple versions of contracts per campaign. In order to see the most recent contract you can use the
?latest=trueproperty when making requests.The
statisticsin the response will be for all contracts on this campaign for the publisher, not per contractcampaignPublisherBandswill always have at least one result. If thecampaignPayoutBandis null then it is the default band.
Example Request
| Code Block |
|---|
GET https://{enterprise}.cvtr.io/api/v4/campaign-publishers?latest=true |
In the same way as the other endpoints, you have an array of filtering options such as ?campaign.id=x
| Code Block |
|---|
{
"@context": "/api/v4/contexts/CampaignPublisher",
"@id": "/api/v4/campaign-publishers",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/campaign-publishers/984",
"@type": "CampaignPublisher",
"id": 984,
"leadsRequired": 10,
"startTs": "2021-09-01T09:55:56+00:00",
"endTs": null,
"signName": "Star Publisher",
"signRole": "Publisher",
"signedTs": "2021-09-01T09:55:56+00:00",
"signedIp": "89.36.71.125",
"updatedTs": "2021-09-01T09:55:56+00:00",
"createdTs": "2021-09-01T09:55:40+00:00",
"terms": null,
"linkHash": "ba9ceff4e807fc7e00d058e0764e365d",
"publisher": {
"@id": "/api/v4/publishers/5",
"@type": "Publisher",
"id": 5,
"name": "Star Publisher",
"email": "test@convertr.io"
},
"campaign": {
"@id": "/api/v4/campaigns/601",
"@type": "Campaign",
"status": "Active",
"id": 601,
"name": "d20210901",
"startTs": "2021-08-31T23:00:00+00:00",
"endTs": "2021-11-30T23:59:59+00:00",
"advertiser": {
"@id": "/api/v4/advertisers/319",
"@type": "Advertiser",
"id": 319,
"name": "Test Advertiser",
"email": "test@convertr.io"
},
"currency": {
"@id": "/api/v4/currencies/1",
"@type": "Currency",
"name": "GBP",
"symbol": "£"
},
"allowPublisherImportExport": true
},
"updatedBy": {
"@id": "/api/v4/users/223",
"@type": "User",
"id": 223,
"username": "cvtr.rokas"
},
"createdBy": {
"@id": "/api/v4/users/223",
"@type": "User",
"id": 223,
"username": "cvtr.rokas"
},
"publisherApplication": {
"@id": "/api/v4/campaign-publisher-applications/709",
"@type": "CampaignPublisherApplication",
"id": 709,
"status": "Accepted"
},
"trackConversion": [],
"current": true,
"campaignPublisherBands": [
{
"@id": "/api/v4/campaign-publisher-bands/1565",
"@type": "CampaignPublisherBand",
"payout": "5.50",
"baseCurrencyPayout": "5.50",
"campaignPayoutBand": null,
"leadsRequired": null,
"statistics": {
"earnings": "16.50",
"baseCurrencyEarnings": "16.50",
"
": 4,
"invalidLeads": 1,
"cautionLeads": 1,
"validLeads": 3,
"billableLeads": 3,
"deliveredLeads": 3,
"heldLeads": 0,
"processingLeads": 0
}
}
],
"uncapped": false,
"capsOnBands": false,
"statistics": {
"earnings": "16.50",
"baseCurrencyEarnings": "16.50",
"totalLeads": 4,
"invalidLeads": 1,
"cautionLeads": 1,
"validLeads": 3,
"billableLeads": 3,
"deliveredLeads": 3,
"heldLeads": 0,
"processingLeads": 0,
"impressions": 0,
"conversions": 2,
"lastConversion": "2021-09-01T10:56:35+01:00",
"clicks": 2
},
"contractType": "cpl",
"fixedAmountPayout": null,
"fixedAmountBasePayout": null,
"fixedAmountFulfilled": null,
"currentContractStatus": "Active"
}
],
"hydra:totalItems": 555,
"hydra:view": {
"@id": "/api/v4/campaign-publishers?latest=true&itemsPerPage=1&page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/campaign-publishers?latest=true&itemsPerPage=1&page=1",
"hydra:last": "/api/v4/campaign-publishers?latest=true&itemsPerPage=1&page=555",
"hydra:next": "/api/v4/campaign-publishers?latest=true&itemsPerPage=1&page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/campaign-publishers{?id,id[],campaign.id,campaign.id[],order[id],createdTs[before],createdTs[strictly_before],createdTs[after],createdTs[strictly_after],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],startTs[before],startTs[strictly_before],startTs[after],startTs[strictly_after],endTs[before],endTs[strictly_before],endTs[after],endTs[strictly_after],publisher.id,publisher.id[],publisher.name,publisherApplication.id,publisherApplication.id[],publisherApplication.status,publisherApplication.status[],campaign.name,order[publisher.id],order[publisher.name],order[publisherApplication.id],order[publisherApplication.status],order[campaign.id],order[campaign.name],order[statistics.invalidLeads],order[statistics.validLeads],order[statistics.cautionLeads],order[statistics.heldLeads],order[statistics.processingLeads],order[statistics.billableLeads],order[statistics.impressions],order[statistics.conversions],order[statistics.clicks],campaign.status[],latest,currentContractStatus[],currentContractStatus}",
"hydra:variableRepresentation": "BasicRepresentation",
"hydra:mapping": [
{
"@type": "IriTemplateMapping",
"variable": "id",
"property": "id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "id[]",
"property": "id",
"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": "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": "startTs[before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_before]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "startTs[strictly_after]",
"property": "startTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_before]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "endTs[strictly_after]",
"property": "endTs",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisher.id",
"property": "publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisher.id[]",
"property": "publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisher.name",
"property": "publisher.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherApplication.id",
"property": "publisherApplication.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherApplication.id[]",
"property": "publisherApplication.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherApplication.status",
"property": "publisherApplication.status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "publisherApplication.status[]",
"property": "publisherApplication.status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.name",
"property": "campaign.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[publisher.id]",
"property": "publisher.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[publisher.name]",
"property": "publisher.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[publisherApplication.id]",
"property": "publisherApplication.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[publisherApplication.status]",
"property": "publisherApplication.status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[campaign.id]",
"property": "campaign.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[campaign.name]",
"property": "campaign.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.invalidLeads]",
"property": "statistics.invalidLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.validLeads]",
"property": "statistics.validLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.cautionLeads]",
"property": "statistics.cautionLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.heldLeads]",
"property": "statistics.heldLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.processingLeads]",
"property": "statistics.processingLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.billableLeads]",
"property": "statistics.billableLeads",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.impressions]",
"property": "query",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.conversions]",
"property": "statistics.conversions",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "order[statistics.clicks]",
"property": "statistics.clicks",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "campaign.status[]",
"property": "campaign.status",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "latest",
"property": "latest",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "currentContractStatus[]",
"property": "currentContractStatus",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "currentContractStatus",
"property": "currentContractStatus",
"required": false
}
]
}
} |