Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Type /Jira to add Jira epics and issues
Page Properties

Platform URL

 https://[enterprise].cvtr.io/v2/dashboard

API Endpoints

 

Epic

Page Properties

Platform URL

 https://[enterprise].cvtr.io/v2/dashboard

API Endpoints

 Retrieving campaign totals and Lead totals widgets statistics:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/statistics

Retrieving a list of campaigns:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/campaigns

Retrieving user settings for dashboard table:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/user-settings

Retrieving links of campaigns:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/campaign-links

Retrieving information of the current user:

Code Block
GET https://{enterprise}.cvtr.io/api/v3/user/current

Retrieving a result container of the global search bar:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/search

Retrieving global notifications:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/notification

Retrieving the global export requests:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/export-requests

Epic

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-16

Jira Legacy
serverSystem JIRA
serverId47839f05-61cf-355f-8da7-a069f30ee70e
keyDAS-17

Document status

Status
titleDRAFT

Document owner

Muge Budak

Technical writers

@ writers

🏠 Feature Overview

After the login process, the user navigated to the Dashboard section which shows campaign totals and the lead totals widgets, also all active and inactive campaigns can be seen from here.

...

The following section contains global elements that can be reached from all sections and pages of the platform. These designs apply to every page.

Global-Sidebar

The sidebar is the main navigation, from here the user can access all the different areas of the platform.

...

Global-Profile

This allows the user to update the profile details and password.

...

Global-Logout

This allows the user to log out from the platform.

...

Global-Search

The global search bar allows the user to search for current/ended campaigns, publishers, advertisers, and leads id’s.

...

Global-Export Requests

This allows the user to find requested export files and download them. The user also can find previously downloaded files.

...

Global-Platform Support

This allows the user to reach Help Centre, Contact Support, and WalkMe.

  • Help Centre: Search through the Help Centre to find articles and guides relevant to questions.

  • Contact Support: Find the best solution to the technical or platform issues, the team reaches the user with the solution after filling out the requested details.

  • WalkMe: Learn more about the product; what each feature does, how it works, and how to use it.

...

Global-Notification Centre

This allows the user to reach performance reports. The dropdown menu will show the most recent reports that have not yet been downloaded. Reports can be downloaded by selecting the PDF file. The attachments such as the invalid reports can be downloaded within the ZIP file.

...

🎯 Objective

Campaign Totals WidgetThis section displays the running monthly totals of: The dashboard section provides an overview of the campaign totals and lead totals. Each widget contains a chart to shows a quick summary of the campaigns and leads.

The user can reach all active and inactive campaigns from here with the campaign's statistics and information. And, also can attain subpages of the campaign quickly via actions buttons, for example, processr and export leads pages.

The main objective is to provide the user to inspect their campaigns and their statistics all in one place.

\uD83E\uDD14 Assumptions

Info

Provide any assumptions/pre requisites that are needed for the feature to work.

\uD83D\uDDD2 Requirements

Requirement

User Story

Importance

Jira Issue

Notes

Campaign Totals

This widget gives a visual representation of all campaign data in the running monthly totals.

The widget shows:

  • Total Revenue (CPL x Billable Leads)

...

  • Impressions

...

  • Clicks

...

  • Conversions

...

  • Billable (Leads)

...

The user also can see the top 5 campaigns which generated the most revenue in the bar chart.

...

Status
colourRed
titleHIGH

Lead Totals

...

This

...

widget gives a visual representation of all lead data in the running monthly

...

totals

...

.

The widget shows:

  • Billable

...

  • Leads

  • Total

...

  • Leads

  • Invalid

...

  • Leads

  • Valid Leads

  • Delivered Leads

The user also can see valid and invalid leads proportion in the pie chart.

...

Status
colourRed
titleHIGH

Active Campaigns Tab

Campaigns on the dashboard are grouped by Active and Inactive. The user can view all active campaigns in the Active Campaigns tab.

Status
colourRed
titleHIGH

Inactive Campaigns Tab

Campaigns on the dashboard are grouped by Active and Inactive. The Inactive Campaigns tab contains all campaigns that are not

...

active, which includes Paused, Ended, Inactive campaigns, as well as those with Setup Required.

...

Status
colourRed
titleHIGH

Status

Campaigns on the platform can have different

...

campaign statuses. The Campaign

...

status is used to quickly show what state the campaign is in. This allows Campaign Managers and other users to quickly see if a campaign is in an unexpected state and therefore needs to be actioned.

Status

Status Descriptions

Image Removed

Active: The status given to all campaigns that are running. Active campaigns will have allocation, be within their start and end dates, and have the Advertiser contract signed.

Image Removed

Inactive: The status given to all campaigns which are not running. This status is given when the current date is earlier than the campaign's start date.

Image Removed

Ended: A campaign that has met its lead allocation will be given this. This status will also be given to any campaigns whose end date has been reached.

Image Removed

Paused: A campaign that has been manually paused. Publishers cannot upload to these campaigns.

Image Removed

Image Removed

Setup Required: A campaign with an unsigned Advertiser contract will have this status.

Status
colourRed
titleHIGH

Campaign ID (Cid)

The 'CID' (Campaign ID) is the unique campaign reference.

 

Status
colourRed
titleHIGH

 

 

Campaign Name

This is the campaign name reference. By clicking the name, the user can reach the campaign overview page.

Status
colourRed
titleHIGH

Advertiser

This is the advertiser reference that has the campaign. By clicking the advertiser, the user can reach the advertiser page and can see the advertiser's all campaigns.

Status
colourRed
titleHIGH

Actions

The Actions menu allows the user to reach the campaign’s Overview, Setup, Publisher, Processr, and Leads pages. Also, the user can export leads easily.

Actions

Descriptions

Overview: By clicking the icon the user can reach the Overview page of the selected campaign. The page contain four widgets: Leads Total, Fulfilment Breakdown, Publisher Breakdown, and Tracking Breakdown.

Image Removed

Setup: By clicking the icon the user can reach the Setup/admin page of the selected campaign. All campaign settings which includes owner, delivery, and financials. Also, the user can delete, pause, and resume the campaign.

Image Removed

Publisher: By clicking the icon the user can reach the Publishers page of the selected campaign. The page contain Publisher Breakdown widget and Publisher list table which assigned to the campaign. The user can assign new publishers to the campaign and can send a email to publishers.

Image Removed

Processr: By clicking the icon the user can reach the Processr page of the selected campaign. The page contain Processr Breakdown widget and Jobs table. The user can add a new job to the campaign: Quality Assurance, Enrichment, Integration and Misc. Connected apps lists in the Pre-Processing tab.

Image Removed

Lead: By clicking the icon the user can reach the Leads page of the selected campaign. The page contain Leads Breakdown widget and Leads list table. The user can flag/manage leads and can import/export leads.

Image Removed

Export Leads: By clicking the icon the user can reach the Export Leads page. After completes the page requirements, the user can export selected leads.

...

Status
colourRed
titleHIGH

Custom Tables

The user can alter columns visibility on the page. Once clicking the cog icon, the user will be able to

...

Requirement

User Story

Importance

Jira Issue

Notes

customise the columns and drag and drop the columns that want to appear on the table, then click Save to update the table. By clicking the toggle on to a field in the active columns, this column will be highlighted in green on the table. 

...

🎯 Objective

Info

Provide details of what the feature is trying to resolve.

\uD83E\uDD14 Assumptions

Info

Provide any assumptions/pre requisites that are needed for the feature to work.

\uD83D\uDDD2 Requirements

Status
colourRed
titleHIGH

Column Filter(s)

The user has to option to filter certain table columns with selected options to filter on.

Custom filters:

  • Current Status: The user can filter by Status on the Inactive Campaigns tab to easily see all Inactive, Ended, Paused and Setup Required campaigns.

  • Cid: filter by campaigns id

  • Country: filter by campaigns country

  • Campaign Name: filter by campaigns name

  • Advertiser: filter by advertiser

Status
colourRed
titleHIGH

 

 

 

 

 

\uD83C\uDFA8 User interaction and design

...

Global - Notification Centre: https://invis.io/D611HDJBV7Y4

Global - Platform Support: https://invis.io/BG101MAKXKNU

Global - Customise Table: https://invis.io/E3WSYVH7SP2

Global - Widgets: https://invis.io/8JR261RU9MF

(question) Open Questions

Question

Answer

Date Answered

...