Versions Compared

Key

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

Page Properties

Platform URL

https://[enterprise].cvtr.io/v2/publishers/

API Endpoints

Add Publisher

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

Import Publishers

POST - https://{enterprise}.cvtr.io/api/v4/publisher-import

Edit Publisher

PUT - https://{enterprise}.cvtr.io/api/v4/publishers/{publisher-ID}

Delete Publisher

DELETE -

https://{enterprise}.cvtr.io/api/v4/publishers/{publisher-ID}

List all Publishers

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

Populate country dropdown

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

List all Campaign for Publisher

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

Publisher Statistics

GET - https://{enterprise}.cvtr.io/api/v4/publisher-statistics?startTs={Date-Time-Stamp}&endTs={Date-Time-Stamp}&publisherId={publisher-ID}

Publisher Lead Statistics

GET - https://{enterprise}.cvtr.io/api/v4/publisher-lead-statistics-chronologies?startTs={Date-Time-Stamp}&endTs={Date-Time-Stamp}&publisherId={publisher-ID}

Get details of Publisher bands for the campaign

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

Resend Assets

POST -

https://{enterprise}.cvtr.io/api/v4/campaign-publisher-send-media-kit

Tracking Info

GET -

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

Contract History

GET - https://{enterprise}.cvtr.io/api/v4/campaign-publishers?campaign.id={campaign-ID}&publisher.id={publisher-ID}

List All lead mapping template

GET -

https://{enterprise}.cvtr.io/api/v4/publisher-lead-import-maps

Lead Import

POST -

https://{enterprise}.cvtr.io/api/v4/leads-import

Lead Export

GET-

https://{enterprise}.cvtr.io/api/v4/campaign-data-fields

GET-

https://{enterprise}.cvtr.io/api/v4/lead-data-fields

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

POST - https://{enterprise}.cvtr.io/api/v4/global-leads-export

Bulk Edit

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

GET- https://{enterprise}.cvtr.io/api/v4/leads-import/form/{formId}/campaign/{campaignId}/form-mapping

POST - https://{enterprise}.cvtr.io/api/v4/bulk-edits

Campaign Performance Report

POST - https://{enterprise}.cvtr.io/api/v4/publisher-campaign-performance

Campaign Information

GET -

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

Epic

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

Document status

...

Status
colourGreen
titleDRAFT

...

REVIEWED

Document owner

Danny Hannah Adam Carter

Technical writers

Danny Hannah Adam Carter Arunima Kurup Prasad Vijay Alexander

Related Content

...

🏠 Feature Overview

Within the Convertr platform, Publishers are the lead data providers.

...

  1. Import Leads

  2. Export Leads

  3. Bulk Edit

  4. Resend Assets

  5. Tracking

  6. Contract History

  7. Campaign Performance Report

  8. Campaign InformationImporting Lead Data into a Campaign

1. Importing leads to a campaign

If the campaign setting ‘Allow publisher users Publishers to import and export their data' is enabled on a campaign, the publisher user will be able to see the 'Import Leads’ option against the campaign.

...

This will open a ‘Import Leads’ modal which allows the user to upload a CSV file containing lead data. A sample file is available for download in the link in the blue banner in the modal.

...

All forms associated with the campaign are available in the ‘Select a form’ dropdown. The user must select the appropriate form and upload the CSV file. Different delimiters are supported in the CSV file- comma, semicolon, tab, pipe. The appropriate delimiter may be selected and the user can proceed to the next step.

The user will be able to proceed to the next step only if they have selected the form and uploaded a CSV file.

...

On the next step, the publisher’s name is automatically populated in the ‘Publisher’ field. They can also provide a tracking link. Select a tracking link helps to identify the channel the imported leads will be applied to. If left unset, the channel for each imported lead will be empty.

...

After configuring their options they can then rename the selected columns for export as well as reorder and/or delete their selections.

...

When exporting they will need to confirm that they understand the terms and conditions before export of the data can start.

>>>screenshot Export Agreement>>>Once confirmedexported, the export report will then go to the Exports sections for the user to download. Here again, they will have to confirm that they understand the terms and conditions before exporting the data.

...

>>screenshot of confirmation dialog >>>, the user can click on Download to export the report to their environment.

...

3. Bulk Edit

If the campaign setting ‘Allow Bulk Edit Editing of data' is enabled on a campaign, the publisher user will be able to see the 'Bulk Edit’ option against the campaign.

...

Using the ‘Bulk Edit’ feature, a publisher can edit data on multiple leads without having to action each lead individually. To use bulk edit, the publisher must first ‘Export’ the leads on the campaign using ‘Lead Export’ option.

Next, in the CSV file, they should make the necessary changes to the lead data, e.g., update the company_size, job_title etc.

The next step is to select the ‘Bulk Edit’ option available against the campaign to upload the updated CSV file.

...

>>working of bulk edit>> Arunima Kurup Prasad On step 1: Upload, the user must select the form and upload the updated CSV file.

...

On step 2: Mapping, the form fields must be mapped to the CSV file. All CSV fields will be defaulted to ‘Do Not Change’.

‘Lead Id’ is a mandatory field and must be mapped to the lead Id field in the CSV file. The changes will be made only if the lead Ids on the campaign match those in the CSV file.

For the fields that need to be updated, the user must select the appropriate field name from the CSV file to map them correctly.

...

On Step 3: Preview, the user will be shown 5 rows previewing the changes to the selected fields. A banner will be displayed showing the number of leads that will be affected by the change. The user has to accept the confirmation checkbox to enable the Save button.

...

When the user clicks on Save, the below confirmation box is shown where the user has to enter the number of leads that will be affected by the change.

...

If the user enters the correct value and clicks on Yes, the changes will be made to the leads and an email will be sent to the user confirming the changes.

...

4. Resend Creative Assets

...

The CSV download of the notifications can be got using the CSV button.

...

...

\uD83D\uDDD2 Summary

Functionality

User Story

1

Value Transformation Listing

Users can see the value transforms listing and edit the ‘Label’, ‘Original Name’ and ‘New Name’ fields

2

Value Transformation > Add

Users can add value transform values using the Add button

3

Value Transformation > Add/Edit

Users can add and edit value transforms using the Add/Edit button

4

Value Transformation > Delete

Users can select and delete multiple value transform lists at a time

5

Value Transformation > Import

Users can import CSV file for 'transform' type of value transforms

6

Value Transformation > Group Listing

Users can see the value transforms groups listing and edit the ‘Id’ and ‘Group Name’ fields

7

Value Transformation > Group > Add

User can create value transform groups in which value transforms can be grouped

8

Value Transformation > Group > Add/Edit

User can add/edit value transform groups

9

Value Transformation > Group > Delete

User can delete value transform groups

10

Value Transformation > Table Filtering

Allows the user to filter the table values using Id, Original Name and New Name fields

11

Value Transformation > Group > Table Filtering

Allows the user to filter the table values using Id and Group Name fields

\uD83D\uDDD2 User Permissions

Publisher ‘organisation(s)’ are created on the platform by an Admin or Agency user, as a listing and a publisher (publisher user role) user is created and associated to the Publisher ‘organisation(s)’ to manage that account.

...