Agencies
- Adam Carter
- Arunima Kurup Prasad
- Anu Kalangi
Platform URL | https://[enterprise].cvtr.io/v2/agencies |
|---|---|
API Endpoints | Saving new Agency details POST Updating Agency details PUT Searching for Agencies GET Associating advertisers to agency GET Selecting ‘Data masking’ option to mark personally identifiable lead information GET Adding/removing custom columns PUT |
Epic | |
Document status | REVIEWED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Anu Kalangi @Arunima Kurup Prasad |
Feature Overview
Agencies are typically data processors and are associated with advertisers. An agency can be associated with multiple advertisers. Agency user(s) may be assigned to an agency and can create, view and update campaigns for the advertisers that their agency is associated with. They can also assign Publishers to the campaign to fulfil the campaign.
Admin users can access the ‘Agencies’ side tab to add/edit/delete agencies on the platform.
Setting up an agency
A super admin or admin user should navigate to Dashboard->Agencies for the agency listing page
The following functionalities are available on this page
Add Agency
Delete Agency
Edit Agency
Associate Advertisers
Data Masking
Additionally it is also possible to search for agencies by their Id or Name. Users can also perform search on the Notes and Last Updated columns. As with many other screens, user can use the ‘Custom Table Views’ option to add/remove columns from the listing table. There is also an option to select the number of items to be displayed per page.
Add Agency
Name | Required | Notes |
Agency Name | Name has to be unique | |
First Name |
| |
Last Name |
| |
Email(s) | It is possible to add multiple mail ids | |
Telephone |
| |
Notes |
|
Delete Agency
In order to delete an agency, user should select an agency and click delete
Edit Agency
In order to edit an agency, user should select the edit icon from the actions column.
Associate Advertisers
In order to associate advertiser(s) to an agency, the user should select ‘Associate Advertiser’ from actions column.
The listing shows only those advertisers that are not already associated with the selected agency. Multiple advertisers may be associated with an agency.
Data Masking
Data Masking is the ability to hide Personally Identifiable lead Information such as email and telephone number.
If data masking is enabled for selected lead data fields for an advertiser, these fields will be whitelisted in the lead view
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Agency Listing | Users can see the table listing all the agencies |
| 2 | Add Agency | Users can add agencies using the Add button |
| 3 | Delete Agency | Users can select and delete multiple agencies at a time |
| 4 | Edit Agency | Users can edit details of an agency using the Edit option available in Actions |
| 5 | Associate Advertisers | Users can associate multiple advertisers to an agency using the Associate option available in Actions |
| 6 | Data Masking | Provides users an option to whitelist fields in the lead view when data masking is enabled |
| 7 | Table Download | Allows user to download the agency list shown on the table |
| 8 | Table Filtering | Allows the user to filter the table values using Id, Company Name and Last Updated |
| 9 | Custom Tables | A user can add, remove and reset columns for custom table |
User Permissions
An agency user is assigned to an agency which in turn is associated with multiple advertisers. The agency user can access campaigns created by the associated advertisers only.