Versions Compared

Key

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

Platform URL

https://[enterprise].cvtr.io/v2/advertisers/[advertiserId]/list-campaigns

API Endpoints

Retrieves the collection of AdvertiserCampaignDefault resources:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults

Creates a AdvertiserCampaignDefault resource:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults

Retrieves/Removes/Replaces a AdvertiserCampaignDefault resource:

Code Block
GET/DELETE/PUT https://{enterprise}.cvtr.io/api/v4/advertiser-campaign-defaults/{id}

Retrieving a list of campaigns:

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

Create a campaign/Quick campaign:

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

Retrieving a list of advertisers:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/advertisers

Retrieving a list of forms:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/forms

Retrieving a list of processr jobs:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/processr-jobs

Retrieving a list of subcategories:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/subcategories

Retrieving list of countries:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/countries

Retrieving information of the users/permissions:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/users

Retrieving list of currencies:

Code Block
GET https://{enterprise}.cvtr.io/api/v4/currencies

Duplicate/Import a campaign:

Code Block
POST https://{enterprise}.cvtr.io/api/v4/campaigns/{campaign_id}/duplicate

Go to campaign details:

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

Customisation of the campaign table column:

Code Block
PUT https://{enterprise}.cvtr.io/api/v4//api/v4/user-settings/advertiser-campaigns-list-key

Epic

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

Document status

Status
colourGreen
titleREVIEWED

Document owner

Danny Hannah Adam Carter

Technical writer(s)

Arunima Kurup Prasad Muge Budak

Related Content

Default Value Settings Advertisers

🏠 Feature Overview

Advertiser user can set up multiple campaigns per advertiser and publishers may be assigned to campaigns to submit leads to the campaigns.

...

Clicking on the ‘Quick Campaign’ button will open the below modal where the user needs to enter the bare minimum details to create a campaign. Any default settings available in Advertiser > Default Value Settings will be available in the newly created campaign.

...

\uD83D\uDDD2 Summary

Functionality

User Story

1

Campaigns Listing

Users can see the campaigns listing under tabs: Active and Inactive. By clicking on the ‘Campaign Name’ hyperlink, they can navigate to the campaign overview page

2

Campaigns > Create

Users can create new campaigns using the ‘Create Campaign’ button and entering the required details in multiple tabs

3

Campaigns > Import

User can Import campaigns of any advertiser using the ‘Import Campaign’ button and including the required settings

4

Campaign > Quick Campaign

Users can use the ‘Quick Campaign’ option to create campaigns quickly without entering all the details

5

Table Download

Allows user to download the campaigns shown on the table

6

Table Filtering

Allows the user to filter some of the table values

7

Custom Tables

A user can add, remove and reset columns for custom table

\uD83D\uDDD2 User Permissions

Admin users and agency users associated with the advertiser can access the Advertisers tab to create/import campaigns.

...