Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 9 Next »

Platform URL

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

API Endpoints

Retrieves the collection of AdvertiserCampaignDefault resources:

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

Creates a AdvertiserCampaignDefault resource:

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

Retrieves/Removes/Replaces a AdvertiserCampaignDefault resource:

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

Retrieving a list of campaigns:

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

Create a campaign/Quick campaign:

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

Retrieving a list of advertisers:

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

Retrieving a list of forms:

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

Retrieving a list of processr jobs:

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

Retrieving a list of subcategories:

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

Retrieving list of countries:

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

Retrieving information of the users/permissions:

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

Retrieving list of currencies:

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

Duplicate/Import a campaign:

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

Go to campaign details:

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

Customisation of the campaign table column:

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

Epic

DAS-14 - Getting issue details... STATUS

Document status

DRAFT

Document owner

Arunima Kurup Prasad Muge Budak

Related Content

🏠 Feature Overview

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

The Campaigns tab lists the Advertiser campaigns and provides options for the user to create campaigns and import campaigns.

Campaign Listing

Active and inactive campaigns are listed under 2 separate tabs- ‘Active Campaigns’ and ‘Inactive Campaigns’ respectively. The user can use the custom table settings to select the details to be shown in the table, such as the campaign ID, name, status, etc.

Users can utilise the search and sort options available for some of the fields such as campaign name, country and duration to search for values and sort the records.

Create Campaign

Clicking on the ‘Create Campaign’ button initiates campaign creation, which requires entering the required fields in 7 steps, as described below.

i. Metrics: The user has to provide the below values in the Metrics tab

Field Name

Required

Notes

Performance Model

(tick)

Sector

(tick)

Category

(tick)

Start Date and End Date

(tick)

End Date Extension

(error)

Unavailable Campaign Logic

(tick)

Publisher Imports & Exports

(error)

Publisher Delivery

(error)

>>>>add screenshot

ii. Owner: This tab captures the ownership details such as account manager, campaign manager of the campaign

Field Name

Required

Notes

Advertiser

(tick)

Campaign Name

(tick)

Account Manager

(error)

Campaign Manager

(error)

Country

(error)

Purchase/Insertion order No.

(tick)

Additional Reference Numbers

(error)

Permissions

(error)

>>>>add screenshot

iii. Financials: This tab captures the financial details such as Contract Value

Field Name

Required

Notes

Currency

(tick)

Conversion Rate

(error)

Uncapped

(error)

Volume Required

(tick) when capped

Total Contract Value

(tick) when capped

Payout metric

(tick)

Publisher Payout metric

(tick)

Per action payout amount

(tick)

Default Publisher Rate

(tick)

Payout Restrictions & Terms

(error)

>>> add screenshot

iv. Tracking: This tab captures details of

Field Name

Required

Notes

Compliance Optin Method

(tick)

Landing Page Provider

(tick)

Data Capture Form

(tick)

when hosted with enterprise

Global Forms

(tick)

Default Destination URL

when hosted with advertiser

>>>> add screenshot

v. Jobs: Using this tab, user can configure the Processr jobs to run for the campaign. The jobs: are selected by default and user may unselect them

>>>>>>> add screenshot

vi. Delivery: This tab captures the ….

Field Name

Required

Notes

Endpoint

(error)

Realtime Delivery

(error)

Call centre services

(error)

>>>>>add screenshot

vii. Review: This tab shows the summary of the values entered for all the fields in all the previous tabs. This helps the user to verify the details and edit them by going back to the relevant tab

>>>> add screenshot

Import Campaign

This feature enables the user to Import an existing campaign from an advertiser. This is helpful when the user needs to create a campaign that has similar settings of an existing campaign. When importing an advertiser’s existing campaign, the user can choose whether to import associated settings such as Publishers, Publisher bands, Scheduled Delivery, etc. By doing so, the effort required to configure a campaign is reduced.

>>>> description>>>>>

Field Name

Required

Notes

Advertiser

✅

Campaign to Import

✅

New campaign name

✅

Leads Required

✅

Currency

✅

Per action payout amount

✅

Start Date and End Date

✅

Include (features)

(error)

add screenshot

Quick Campaign

Another option to create campaigns easily is using the ‘Quick Campaign’ functionality. This option will be enabled for an Advertiser if ‘Performance Sector’ and ‘Default Publisher Rates’ are configured in Default Value Settings. Clicking on the ‘Quick Campaign’ button….

add screenshot

\uD83D\uDDD2 User Permissions

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

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

  • No labels