Versions Compared

Key

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

Retrieving Suppression Lists

GET-
Page Properties

Platform URL

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

API Endpoints

Page Properties
QA

Platform URL

https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/validation-lists

API Endpoints

Retrieves Suppression/Validation Lists:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/suppression-lists

Creates Suppression/Validation Lists:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/suppression-lists

Retrieves Suppression/Validation Values:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/suppression-list-values

Creates Suppression/Validation Values:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/suppression-list-values

Downloads Suppression/Validation Values:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/suppression-list-download

Upload CSV file containing Suppression/Validation Values:

Code Block
https://{enterprise}.cvtr.io/api/v4/files/csv

Import Suppression/Validation Values:

Code Block
https://{enterprise}.cvtr.io/api/v4/suppression-list-values/import

Retrieves/Removes/Replaces a Suppression/Validation Values:

Code Block
GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/suppression-lists/{id}

Epic

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

Document status

Status
colourGreen
titleDRAFTREVIEWED

Document owner

Anu Kalangi

Designer

@ designer

Tech lead

@ lead

Technical writers

@ writers

Adam Carter

Technical Writers

Anu Kalangi Muge Budak Arunima Kurup Prasad

Related Content

https://convertr.atlassian.net/l/cp/aGdPsUqe

🏠 Feature Overview

Validation Lists

Validation lists allows allow users to check the leads against the list of values to either target or supress suppress and pass/reject a lead based on the condition selected. For example, if the user is targeting a list of specific companies in a campaign, the user can set up a validation list to ensure that the lead data contains only the exact values required.

Validation Lists can be set up in two areas:

  1. System Level

...

  1. : Lists applied at this level will be accessible across all campaigns in your enterprise. Please refer the documentation mentioned in ‘Related Content’ above

  2. Advertiser Level

...

  1. : Lists applied at this level will only be available to campaigns set up under this advertiser.

Setting Up Validation Lists At An Advertiser Level

Click Add

When adding a entry to the validation list, user enter the following fields and clicks SaveBy clicking on the ‘View’ button or on the ‘Company Name’ hyperlink on the Advertiser listing page, the user will be able to see the Validation Lists menu, based on their user role.

The page lists validation lists configured for the advertiser. Users have the option to perform search on some of the columns. There is also a ‘download’ icon at the bottom of the table which will download the contents of the table as a CSV file.

...

The Add button opens a modal as shown below. Here the user must provide a name for the validation list and specify if it should be a private list.

...

Name

Required

Notes

Name

(tick)

Enter the validation list name

Private Privatise

(tick)

Private Privatise toggle affects the view of the list for any Agency type users on your platform. If set to Private, Agency users will not be able to see the values that are added to the list, or make any changes to it. The role of private validation lists is to allow the advertiser to upload potentially sensitive information without exposing it to Agency or Publisher user types.

Admin + Super Admin users should still be able to see private validations lists.

Clicking on Save will open an Add Validation List modal where a modal called ‘Add Validation List’. Here, the user can either add values or Import values.

...

🎯 Objective

The advertiser is the client accepting the leads. The advertiser will be able to set up multiple campaigns per advertiser and assign publishers to campaigns to provide leads to these campaigns.

\uD83E\uDD14 Assumptions

Info

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

\uD83D\uDDD2 Requirements

User Permissions

The users should have access to the advertisers to be able to view the advertisers

...

Requirement

...

User Story

...

Importance

...

Jira Issue

...

Notes

...

Status
colourRed
titleHIGH

...

 

...

 

...

 

...

 

...

 

\uD83C\uDFA8 User interaction and design

Advertiser-Create Campaign -https://www.figma.com/proto/XSFJYyCCNM0Z41Lh961pMm/ADVERTISERS---Create-Campaign-V3?scaling=min-zoom&page-id=0%3A1&starting-point-node-id=9%3A2&node-id=9%3A2

Advertiser- Import-https://www.figma.com/proto/AsU5TdoA31PwSqZsuTRKY4/ADVERTISER---Import?node-id=2%3A7&scaling=min-zoom&page-id=0%3A1&starting-point-node-id=2%3A7

Advertiser- Validation Lists-https://invis.io/WQ10SOR1P56B

Advertiser-Value Transform-https://invis.io/MEUGRPETYWK

https://invis.io/59UA4R5H3QR

(question) Open Questions

...

Question

...

Answer

...

Date Answered

(warning) Out of Scope

...

import values into the list.

Add Values

User can add values by entering the details in ‘New Value’ and clicking on ‘Add’.

...

Import Values

If the user chooses to import values to the list, they can do so by selecting the ‘Import Values’ tab which will allow the user to upload a CSV file containing the values. Sample CSV file for reference can be downloaded by clicking on the link in the blue banner.

...

Values added/imported will be listed as shown below.

...

Users can remove individual values from the list by checking the corresponding checkbox and clicking on ‘Remove’ button. Alternately, the user can remove all values from the list by clicking on the ‘Remove All’ button.

Add/Edit

Existing validation lists may be edited using the Add/Edit button available on the the listing table.

...

Download

Clicking on the Download button will make the validation list available under Exports option. User can then download the list to their environment.

...

\uD83D\uDDD2 Summary

Functionality

User Story

1

Validation Lists

Users can see the table listing all the validation lists and can edit the name of the validation list and make them private/non private

2

Validation Lists > Add

Users can add private and non private validation lists

3

Validation Lists > Add/Edit

Users can add, import and remove values in the validation lists

4

Validation Lists > Delete

Users can select and delete multiple Validation Lists at a time

5

Validation Lists > Download

Users can download the contents of a validation list using the Download button available in Actions

6

Advertisers > Create Campaign

Allows users to create campaigns for the advertiser

7

Table Download

Allows user to download the validation lists shown on the table

8

Table Filtering

Allows the user to filter the table values using Id and Name

\uD83D\uDDD2 User Permissions

Admin users, agency users and advertiser users associated with the advertiser can access this tab.

https://docs.google.com/spreadsheets/d/1i4qTTKkC3rF3EyEOh2585ktDDGge0L0IMVDNCwriFR0/edit#gid=1710197291 Connect to preview