Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 4 Next »

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/publishers

API Endpoints

Load Campaign Details

GET /api/v4/campaigns/{campaigId}

Load Campaign Publisher list

GET api/v4/campaign-publishers

Resend Publisher Contract/Update Contract Terms

POST api/v4/campaign-publishers

GET api/v4/campaign-publisher-totals?campaign.id={campaignId}

Enable/Disable

PUT api/v4/campaign-publisher-applications

Listing table: custom column

PUT api/v4/user-settings/campaign-publisher-list-key

Totals table: custom column

PUT api/v4/user-settings/campaign-publisher-totals-list-key

Epic

Document status

DRAFT

Document owner

Danny Hannah Adam Carter

Technical writers

Arunima Kurup Prasad

Related Content

Campaign > Publishers

🏠 Feature Overview

Publisher assignment to a campaign can be done by Admin and Agency users, using the Campaign > Publishers page. This can be accessed by selecting the campaign from the dashboard and clicking on the Publishers tab.

This page shows the details of assigned publishers, publisher breakdown details, and total leads details.

  1. Publisher Breakdown widget

This widget shows the below details:

i. total earnings for all publishers assigned on the campaign.

ii. Number of publishers

iii. Number of active publishers

iv. Number of publishers who have not .signed the contract

v. Number of publishers that have been disabled on the campaign

  1. Leads breakdown graph

This graph shows the number of billable leads and number of remaining leads per publisher

  1. Publishers table

This table lists the details of all publishers assigned to the campaign.

The following details are available in the table by default:

Name

Notes

Id

Publisher Id

Lead Generator

Name of the publisher

Contract Status

Unsigned: When contract is not signed by publisher

Active: When contract is signed

Inactive: When publisher is disabled and configured to not deliver leads

Enabled

If disabled,ASDFGHJ fill in the blanks

Contract Type

CPL

Processing

Number of leads that are in processing state

On Hold

Number of leads that are in hold state (awaiting batch or scheduled delivery)

Total Leads

Total number of leads submitted by the publisher

Valid

Total number of valid leads submitted by the publisher

Invalid

Total number of invalid leads submitted by the publisher

Billable

Total number of billable leads submitted by the publisher

Required

Total number of leads required from the publisher

Payout

Payout value configured for cap/per band

Earnings

The total earnings made by the publisher for the billable leads

Actions

A number of actions are possible, as detailed in this page

Apart from the above, the user can select the ‘Custom Table Views’ option to add/remove columns. Additional columns that may be added are:

Name

Notes

Impressions

Number of impressions

Clicks

Name of clicks

Conversions

Number of clicks converted to leads

Last Conversion

Date when a click was last converted

Pending Batch

Number of leads pending batch

Apart from custom table views, the publisher table also provides a number of search and filter options.

Pagination and table level refresh are also possible on the publishers table.

Actions

The

  • search and filter options available on table columns, if any

  • custom table views, pagination, if available

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

2

3

4

5

6

7

8

Table Filtering

Allows the user to filer the table values using Advertiser Id, Advertiser Name, Campaign Id, Campaign Name and Label

9

Custom Tables

A user can add, remove and reset columns for custom table

\uD83D\uDDD2 User Permissions

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=415459484

  • No labels