Dashboard
- Adam Carter
- Arunima Kurup Prasad
- Muge Budak
Objective
The dashboard section provides an overview of the campaign totals and lead totals. Each widget contains a chart to show 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 lead's pages.
The main objective is to provide the user to inspect their campaigns and their statistics all in one place.
Platform URL | |
|---|---|
API Endpoints | Retrieving campaign totals and Lead totals widgets statistics: GET https://{enterprise}.cvtr.io/api/v4/statisticsRetrieving a list of campaigns: GET https://{enterprise}.cvtr.io/api/v4/campaignsRetrieving user settings for dashboard table: GET https://{enterprise}.cvtr.io/api/v4/user-settingsRetrieving links of campaigns: Retrieving information of the current user: Retrieving campaign totals and Lead totals widgets statistics: Retrieving a result container of the global search bar: Retrieving global notifications: Retrieving the global export requests: Retrieving all the features on the page: |
Epic | |
Document status | DRAFT |
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 & Pasword
This allows the user to update the profile details and password.
Global - Logout
This allows the user to log out from the platform.
Global - Header - Search
The global search bar allows the user to search for campaigns, advertisers, publishers, and leads. The user needs to search exact id/name or id/email to see the filtered result list.
Global - Header - Export Requests
This allows the user to find requested export files and download them. The user also can find previously downloaded files.
Global - Header - Platform Support Dropdown
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.
Feedback: Hotjar feedback for customer experience.
Feedback | Contact Us | Walkme |
|---|---|---|
|
|
|
Global - Header - 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.
Dashboard - Campaign Status
Users can filter campaigns by Active Campaign, the criteria for this is:
Start and End date within a live date range
The advertiser contract has been signed
Users can filter campaigns by Inactive Campaign, the criteria for this is:
Start and End date has past or Start and End date is set in the future date range
The campaign cap has been reached
The campaign is paused
The advertiser contract has not been signed
Summary
Feature | User Story |
|---|---|
Campaign Totals Widget
| This widget gives a visual representation of all campaign data in the running monthly totals. The widget shows:
The user also can see the top 5 campaigns which generated the most revenue in the bar chart. |
Lead Totals Widget | This widget gives a visual representation of all lead data in the running monthly totals. The widget shows:
The user also can see valid and invalid leads proportion in the pie chart. |
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. |
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 | 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. 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. 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. 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. Paused: A campaign that has been manually paused. Publishers cannot upload to these campaigns. Setup Required: A campaign with an unsigned Advertiser contract will have this status. |
Campaign ID (Cid) | The 'CID' (Campaign ID) is the unique campaign reference. |
Campaign Name | This is the campaign name reference. By clicking the name, the user can reach the campaign overview page. |
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. |
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. 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. 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. 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. 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. 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. 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. |
Custom Tables | The user can alter columns visibility on the page. Once clicking the cog icon, the user will be able to 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. |
Column Filter(s) | The user has to option to filter certain table columns with selected options to filter on. Custom filters:
|
User Permissions
Admin and agency users have access to all widgets and campaign listing table.
Advertiser users, Call Centre users, Report users and Advertiser Report users have access to limited features.
Publisher users do not have access to the Dashboard.
https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=0