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 8 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

Technical writers

Arunima Kurup Prasad

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

Description

Whether Mandatory

Performance Model

Sector

Category

Start Date and End Date

End Date Extension

Unavailable Campaign Logic

Publisher Imports & Exports

Publisher Delivery

>>>>add screenshot

ii. Owner

Field Name

Description

Whether Mandatory

Advertiser

Campaign Name

Account Manager

Campaign Manager

Country

Purchase/Insertion order No.

Additional Reference Numbers

Permissions

>>>>add screenshot

iii. Financials

Field Name

Description

Whether Mandatory

Currency

Conversion Rate

Uncapped

Volume Required

✅ when capped

Total Contract Value

✅ when capped

Payout metric

Publisher Payout metric

Per action payout amount

Default Publisher Rate

Payout Restrictions & Terms

>>> add screenshot

iv. Tracking

Field Name

Description

Whether Mandatory

Compliance Optin Method

Landing Page Provider

Data Capture Form

✅ when hosted with enterprise

Global Forms

✅ when

Default Destination URL

when hosted with advertiser

>>>> add screenshot

v. Jobs

>>>>>>> add screenshot

vi. Delivery

Field Name

Description

Whether Mandatory

Endpoint

Realtime Delivery

Call centre services

>>>>>add screenshot

vii. Review

>>>> add screenshot

Import Campaign

>>>> description>>>>>

Field Name

Description

Whether Mandatory

Advertiser

Campaign to Import

New campaign name

Leads Required

Currency

Per action payout amount

Start Date and End Date

Include (features)

add screenshot

Quick Campaign

>>>> description>>>>>

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