Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

🎯 Objective

...

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

Page Properties

Platform URL

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

API Endpoints

 Retrieving campaign totals and Lead totals widgets statistics:

...

GET

...

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

Retrieving a list of campaigns:

...

GET

...

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

Retrieving user settings for dashboard table:

...

GET

...

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

Retrieving links of campaigns:

...

GET

...

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

Retrieving information of the current user:

...

GET

...

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

Retrieving a result container of the global search bar:

...

GET

...

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

Retrieving global notifications:

...

GET

...

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

Retrieving the global export requests:

...

GET

...

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

Retrieving all the features on the page:

...

GET

...

https://{enterprise}.cvtr.io/api/v4/features

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 & Pasword

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

...

Global - Logout

This allows the user to log out from the platform.

...

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

Image RemovedImage Added

Image RemovedImage Added

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.

...

\uD83E\uDD14 Assumptions

...

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

...

\uD83D\uDDD2 Requirements

...