...
To get configured jobs on the campaign, you’ll need to call the following endpoint:
| Code Block |
|---|
GET https://{enterprise}.cvtr.io/api/v4/campaign-processr-jobs |
...
| Code Block |
|---|
{
"@context": "/api/v4/contexts/CampaignProcessrJob",
"@id": "/api/v4/campaign-processr-jobs",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/campaign-processr-jobs/7121",
"@type": "CampaignProcessrJob",
"id": 7121,
"stage": 50,
"score": 0,
"hardfail": false,
"visible": true,
"enabled": true,
"updatedTs": "2021-09-01T09:55:27+00:00",
"campaign": {
"@id": "/api/v4/campaigns/601",
"@type": "Campaign",
"status": "Active",
"id": 601,
"name": "Test Campaign"
},
"processrJob": {
"@id": "/api/v4/processr-jobs/1024",
"@type": "ProcessrJob",
"id": 1024,
"defaultJob": false,
"name": "Batch CSV Integration",
"defaultScore": 0,
"defaultHardfail": false,
"description": "",
"processrJobCategory": {
"@id": "/api/v4/processr-job-categories/2",
"@type": "ProcessrJobCategory",
"id": 2,
"name": "Integration"
},
"updated": null
},
"updatedBy": {
"@id": "/api/v4/users/223",
"@type": "User",
"id": 223,
"username": "cvtr.test"
},
"label": "",
"campaignMapping": [],
"routeByScoreMinimum": null,
"routeByScoreMaximum": null,
"routingValues": [],
"shownOnCampaign": false,
"config": [
],
"alwaysDeliver": false,
"campaignProcessrJobGroupJob": [],
"statistics": {
"total": 3,
"passed": 3,
"failed": 0
},
"unmappedFields": []
}
],
"hydra:totalItems": 574,
"hydra:view": {
"@id": "/api/v4/campaign-processr-jobs?itemsPerPage=1&processrJob.processrJobCategory.id=2&page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/campaign-processr-jobs?itemsPerPage=1&processrJob.processrJobCategory.id=2&page=1",
"hydra:last": "/api/v4/campaign-processr-jobs?itemsPerPage=1&processrJob.processrJobCategory.id=2&page=574",
"hydra:next": "/api/v4/campaign-processr-jobs?itemsPerPage=1&processrJob.processrJobCategory.id=2&page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/campaign-processr-jobs{?id,id[],campaign.id,campaign.id[],order[id],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after],processrJob.processrJobCategory.id,processrJob.processrJobCategory.id[],processrJob.processrJobCategory.name,processrJob.id,processrJob.id[],shownOnCampaign,alwaysDeliver,grouped}",
"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": "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": "processrJob.processrJobCategory.id",
"property": "processrJob.processrJobCategory.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJob.processrJobCategory.id[]",
"property": "processrJob.processrJobCategory.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJob.processrJobCategory.name",
"property": "processrJob.processrJobCategory.name",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJob.id",
"property": "processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "processrJob.id[]",
"property": "processrJob.id",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "shownOnCampaign",
"property": "shownOnCampaign",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "alwaysDeliver",
"property": "alwaysDeliver",
"required": false
},
{
"@type": "IriTemplateMapping",
"variable": "grouped",
"property": "grouped",
"required": false
}
]
}
} |
Campaign bands
Bands are defined on a campaign level and linked to Publisher contracts.
| Code Block |
|---|
GET https://{enterprise}.cvtr.io/api/v4/campaign-payout-bands |
Response:
| Code Block |
|---|
{
"@context": "/api/v4/contexts/CampaignPayoutBand",
"@id": "/api/v4/campaign-payout-bands",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/v4/campaign-payout-bands/162",
"@type": "CampaignPayoutBand",
"fieldName": "country",
"value": "United Kingdom",
"bandName": "UK Band",
"defaultRate": 20
}
],
"hydra:totalItems": 150,
"hydra:view": {
"@id": "/api/v4/campaign-payout-bands?itemsPerPage=1&page=1",
"@type": "hydra:PartialCollectionView",
"hydra:first": "/api/v4/campaign-payout-bands?itemsPerPage=1&page=1",
"hydra:last": "/api/v4/campaign-payout-bands?itemsPerPage=1&page=150",
"hydra:next": "/api/v4/campaign-payout-bands?itemsPerPage=1&page=2"
},
"hydra:search": {
"@type": "hydra:IriTemplate",
"hydra:template": "/api/v4/campaign-payout-bands{?id,id[],campaign.id,campaign.id[],order[id],updatedTs[before],updatedTs[strictly_before],updatedTs[after],updatedTs[strictly_after]}",
"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": "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
}
]
}
} |