Setup
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/campaigns/{campaignId}/admin/setup |
|---|---|
API Endpoints | Metrics tab Retrieve country list
Retrieve categories list
Financials tab Retrieve currency list
Permissions tab Retrieve user permissions and users
'Grant All'
Revoke user permissions
Advanced tab Retrieve processr jobs and suppression lists
Metadata tab Retrieve metadata fields
Update value for metadata
SAVE campaign settings
|
Epic | |
Document status | APPROVED |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad @Barnaby Murtagh (Unlicensed) |
Related Content |
Feature Overview
Any changes to the campaign configuration after it is created, can be done by the Admin/Agency users on the ‘Campaign Settings’ section. This is available in Setup under the Campaign > Admin menu.
The workflow is similar to the Create Campaign workflow and is composed of 7 steps.
i. Metrics
Some of the fields are similar to the 'Metrics' tab in the Create campaign flow.
Field Name | Editable | Notes |
|---|---|---|
Performance Model |
| |
Sector |
| |
Category |
| |
Start Date and End Date |
| |
Publisher Imports & Exports |
| |
Allow Bulk Editing of Data | This is not available in the create campaign flow. This setting determines whether bulk editing option should be enabled on the campaign. |
ii. Owner
This tab is the same as the ‘Owner’ tab in the Create campaign flow except for the ‘Permissions’ details. In the campaign settings, the permission details are available as a separate tab. The Owner tab displays the ownership details such as account manager, campaign manager, etc. of the campaign.
Field Name | Editable | Notes |
|---|---|---|
Advertiser | Shows the name of the Advertiser against which the campaign is created | |
Campaign Name |
| |
Account Manager |
| |
Campaign Manager |
| |
Country |
| |
Purchase/Insertion order No. |
| |
Additional Reference Numbers |
|
iii. Financials
This tab displays the financial details of the campaign, as configured in the create campaign flow. The Financials tab also has 2 additional non mandatory fields- ‘Default Sale Value’ and 'Default Sale Currency'.
Field Name | Editable | Notes |
|---|---|---|
Currency |
| |
Conversion Rate |
| |
Volume Required | Available only for capped campaign | |
Payout metric |
| |
Publisher Payout metric |
| |
Per action payout amount |
| |
Default Publisher Rate |
| |
Default Sale Value | Overwrites any value passed within a Sales event tracking tag | |
Default Sale Currency | Overwrites any value passed within a Sales event tracking tag |
iv. Permissions
This tab contains the permission details configured under the ‘Permissions’ section in the ‘Owner’ tab in the create campaign flow.
The table lists all users that can have access to the campaign. Individual users can be granted/revoked access to/from the campaign using the toggle option under ‘Access’ column.
The ‘Grant All’ button may be clicked if all the users on the given page, need to be granted access to the campaign.
v. Delivery:
The Delivery tab provides settings to configure leads delivery . The following fields are available in this tab.
Field Name | Editable | Notes |
|---|---|---|
Enable Realtime Delivery |
| Same as in create campaign flow |
Score Based Routing | Whether leads should be delivered to different integrations based on lead score | |
Value Based Routing | Whether leads should be delivered to different integrations based on a value on the lead | |
Call Centre Services | Same as in create campaign flow | |
Welcome Email | Whether a welcome email should be sent to publisher when assigned | |
Double Optin | Same as in create campaign flow > Tracking tab | |
Send Media Kit | Whether media kit should be sent to publisher when assigned | |
Hold Publisher Over delivery | Whether leads from a publisher should be held without integrating, if they exceed the publisher cap configured | |
Lead Process Delay | Whether a delay (in minutes) should be set for processing leads | |
Unavailable Campaign Logic | Same as the field in ‘Metrics’ tab in create campaign flow | |
Redirect URL | Same as in create campaign flow > Metrics tab | |
End Date Extension | Same as the field in ‘Metrics’ tab in create campaign flow | |
Stale Leads Threshold | The minimum number of days after which a lead will be marked as stale/invalid, if undelivered |
vi. Advanced
The Advanced tab provides additional configurations for the campaign which are not available in the create campaign workflow.
The configurations and their description are given below:
Field Name | Notes |
|---|---|
Publisher Notes | Any notes that the publisher must see when they are in the campaign can be configured here |
Campaign API Key | Non editable API key which functions as an access token for the duration of the campaign. Publishers deliver leads to the platform using a Campaign webhook, which allows them to post data to the campaign using the Campaign API key. |
Publisher Names |
|
Test Mode | If this is enabled, leads in the campaign will be delivered to integrations regardless of their QA status but they will not be billable. This will not work if routing is enabled on the campaign. |
Publisher Contract Auto Signing | If this is enabled, publisher contracts will be automatically signed and publisher media kits will not be sent to the publishers. |
Manual Score | If this is selected, we can manually set score for leads to pass in the 'Minimum Lead Quality Score'. Any leads that have a score above this value will be marked a valid. |
Set ‘Returned’ Flag Reason | If enabled, for Convertr Connect integrations, if leads marked as invalid, this will set 'Returned' as the default reason at the receiving enterprise. |
Exclude from Business Insights | If enabled, this campaign will not be included in Enterprise > Business Insights |
vii. Metadata
The final tab in campaign settings is the Metadata tab which will be available only if metadata is configured in Enterprise > Metadata.
On this tab, user can configure the values for ‘Metadata’ fields configured in Enterprise > Metadata.
If values are configured, these will be available in campaign level and will be available for reporting in Report Builder and Campaign Lead Export.
Summary
Summarise the functionalities in a table
Functionality | User Story | |
|---|---|---|
| 1 | Campaign Setup | Admin and Agency users can see the campaign details, make changes to some of the fields and configure additional campaign settings related to delivery, metadata etc. |
User Permissions
Only Admin and Agency users have access to this section of the platform.