Campaign > Overview
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/overview |
|---|---|
API Endpoints | Display publisher earnings, billable leads, invalid leads, valid leads etc.
Leads breakdown widget
Leads chronological statistics chart
Return all publishers on the campaign
Return all tracking links on the campaign
|
Epic | |
Document status | DRAFT |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad |
Related Content | https://convertr.atlassian.net/jira/software/projects/PFD/boards/33?selectedIssue=PFD-9 |
Feature Overview
On the dashboard, when an admin or agency user clicks on the campaign link, they are redirected to the Campaign overview page.
The Campaign overview page, as the name indicates, provides an overall view of the campaign, using widgets and graphs, displaying values such as total leads required, delivered leads, number of impressions converted to clicks etc.
The Campaign overview page consists of 4 widgets:
Lead Totals
Fulfilment Breakdown
Publisher Breakdown
Tracking Breakdown
Lead Totals
This widget shows the following values:
Billable Leads: Total number of leads in the campaign, that are billable for the advertiser
Leads: Total number of leads in the campaign
Invalid: Total number (and percentage) of invalid leads in the campaign
Valid: Total number (and percentage) of valid leads in the campaign
Delivered: Total number (and percentage) of delivered leads in the campaign
There is also a visual representation of the number (and percentage) of valid and invalid leads on the campaign, shown as a pie chart, adjacent to the widget.
Fulfilment Breakdown
This widget shows the revenue fulfilment of the campaign. The values displayed on this widget are as follows:
Revenue: Is calculated as Number of billable leads x Cost per lead (CPL). In the above example, there are 118 billable leads and CPL is configured as €10. Hence the revenue amount is €1180.
Leads Required: Is the total campaign requirement
Fulfilled: Is the number (and percentage) of billable leads on the campaign
Remaining: Is calculated as Leads Required - Fulfilled
Publisher Breakdown
This widget shows the details of publishers on the campaign. The values available are:
Total Publisher Earnings:
Publishers: Total number of publishers assigned to the campaign
Active: Total number (and percentage) of active publishers on the campaign
Disabled: Total number (and percentage) of inactive or disabled publishers on the campaign
Unsigned: Total number (and percentage) of publishers on the campaign who haven’t signed the contract
The widget is also accompanied by a bar graph that shows a visual representation of the number of leads remaining per publisher and billable leads per publisher
Tracking Breakdown
This widget contains data that can be used for tracking purposes.
Impressions to Clicks conversion
Links: Total number of links created
Active: Total number of active links
Inactive: Total number of inactive links
Summary
Summarise the functionalities in a table
Functionality | User Story | |
|---|---|---|
| 1 | Lead Totals | Admin and agency users can see the Total number of leads in the campaign, total leads that are billable for the advertiser, Total number (and percentage) of invalid leads, Total number (and percentage) of valid leads and Total number of Delivered leads in the campaign |
| 2 | Fulfilment Breakdown | Admin and agency users can see the Total Revenue, Leads Required, Total number of fulfilled leads and total number of remaining leads on the campaign |
| 3 | Publisher Breakdown | Admin and agency users can see the total Publisher Earnings, Total number of publishers assigned to the campaign, Total number (and percentage) of active publishers on the campaign, Total number (and percentage) of inactive or disabled publishers on the campaign and Total number of unsigned contracts in the campaign |
| 4 | Tracking Breakdown | Admin and agency users can see the Impressions to Clicks conversion, Total number of links created, Total number of active and inactive links in the campaign |
User Permissions
Admin and agency users only can access the campaign overview page.