/
Campaign > Leads Listing

Campaign > Leads Listing

 

Platform URL

https://[enterprise].cvtr.io/v2/campaigns/[campaignId]/leads

API Endpoints

Leads breakdown widget

GET /api/v4/statistics

Leads chronological statistics chart

GET /api/v4/lead-statistics-chronologies

Lead listing table displaying campaign, lead and lead generator details

GET /api/v4/leads

GET /api/v4/campaigns

GET api/v4/campaign-publishers

GET api/v4/processr-job-leads

Epic

https://convertr.atlassian.net/browse/DAS-56

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 https://convertr.atlassian.net/jira/software/projects/PFD/boards/33?selectedIssue=PFD-11

Feature Overview

Once the user selects a campaign, they can see the lead data in the campaign by clicking on the ‘Leads’ menu.

The Global Leads page is different from the Campaign > Leads page in that, the former lists all leads across all active campaigns on the platform, and the latter lists leads specific to the selected campaign.

The lead view enables the user to understand the lead data to be able to perform an action on a lead.

The Leads page provides the below options:

  1. Leads Breakdown widget

  2. Leads Statistics graph

  3. Leads Listing table

  4. Detailed lead view

  5. Lead filtering

  6. Custom tables

  7. Table download and pagination

  8. Table refresh and

  9. Choice to perform a multitude of actions such as:

    1. Import Leads

    2. Export Leads

    3. Bulk Edit of leads

    4. Flag/Manage leads

    5. Suppression lists

Leads Breakdown widget

The ‘Leads Breakdown’ widget shows breakdown of all lead data on the campaign. The widget shows Total number of leads, Billable leads, Invalid leads (and percentage), Valid leads (and percentage) and Delivered leads (and percentage) in the campaign.

Lead Statistics graph

Next to the leads breakdown widget is a graph showing the chronological leads statistics. The user can select the date range for which they want to see the lead data.

The graph shows the Total leads, Valid leads and Invalid Leads for the selected period.

Leads Table

Below the breakdown widget and the statistics graph, is the Leads listing page, shown below.

The table has 14 default columns, as described below. Using the custom table view, users can add/remove columns from the table.

Column

Description

Column

Description

Id

Lead Id

Date

Lead Created Date

Lead Generator

Name of the publisher

Channel

 

First Name

 

Last Name

 

Email

 

Processr Status

 

Current Status

 

Delivery

Whether delivered

Billable for Publisher

Whether billable for Publisher

Billable for Advertiser

Whether billable for Advertiser

Sales

 

Actions

Contains View button to view details of individual lead

Additionally, there is a column with checkboxes to select lead(s) for performing an action on the lead(s).

Custom Table View

As with many other tables, the lead listing table also provides a custom table option where users can select and deselect columns to show on the table.

Pagination

There is an option for pagination wherein the user can select the number of records to show on a single page. User can choose to display 10, 25, 50 or 100 records per page. Using the navigation arrows, users can go to next and previous pages.

Table Download

The table also comes with a download option, at the bottom.

By clicking on the button, the paginated table contents will be downloaded to the user’s local machine, once they agree to the terms and conditions shown before the download.

Table Refresh

The listing table also comes with a ‘Refresh’ button at the bottom, for the users to reload the table instead of performing a page refresh to view any changes to the lead data (e.g. impact of Flag/Manage, Bulk Edit, Import, Export etc. on lead view).

Column Filters

As with many other tables, The Campaign > Leads table provides filters for most of the columns:

Column Filter

Description

Column Filter

Description

Id

Filter by Lead Id

Date

Filter by Lead Created Date

Lead Generator

Filter by publisher name

Channel

Filter by channel

First Name

Filter by lead’s first name

Last Name

Filter by lead’s last name

Email

Filter by lead’s mail ID

Processr Status

Filter by processr status(es)

Current Status

Filter by current status: valid, invalid, test or caution

Delivery

Filter by delivery status

Billable for Publisher

Filter by whether billable for Publisher or not

Billable for Advertiser

Filter by whether billable for Advertiser or not

Apart from the above, the user can perform a multitude of different actions on the lead data such as:

  • View individual lead data

  • Import Leads into the campaign

  • Export leads from the campaign

  • Flag/Manage leads

  • Apply email and telephone suppression lists to the campaign

  • Bulk Edit lead data

These are described in the sections mentioned in ‘Related Content’

Summary

Functionality

User Story

Functionality

User Story

1

Leads breakdown widget

Shows breakdown of leads (total, valid, invalid, delivered, billable leads) in the campaign

2

Leads chronological statistics

Shows leads statistics as a graph across selected date range

3

Lead listing

Lists all leads in the campaign

4

Table Filtering

Allows user to filter leads on different columns

5

Pagination

Allows user to choose number of records to view per page

6

Custom table view

Allows user to select columns they want to view

7

Table download

Allows user to download contents of the table

 User Permissions

Admin and agency users have access to the Campaign > Leads page. Advertiser users and call centre users have access to limited areas and functionalities on the page. For details on user permissions, please refer the user permission matrix link below.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit?pli=1#gid=1693497632

Related content

Global Leads > Listing
Global Leads > Listing
More like this
Processr Jobs Groups
Processr Jobs Groups
Read with this
Campaign > Overview
Campaign > Overview
More like this
TEMPLATE: Documentation - make a copy
TEMPLATE: Documentation - make a copy
Read with this
Global Leads > Actions > View
Global Leads > Actions > View
More like this
Campaign Leads > Actions > View
Campaign Leads > Actions > View
More like this