Versions Compared

Key

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

Platform URL

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

API Endpoints

Fetching lead info

GET api/v4/lead-datas

Associated Campaigns tab

GET api/v4/leads

GET api/v4/statistics

GET api/v4/campaign-links

GET api/v4/lead-statistics-chronologies

GET api/v4/campaign-publishers

GET api/v4/campaigns

Job Details tab

GET api/v4/processr-job-leads

GET api/v4/campaign-processr-jobs

Processr Logs tab

GET api/v4/logs

Provider Logs tab

GET api/v4/logs

Edit Data tab

GET api/v4/lead-editable-fields

POST api/v4/lead-datas

Notes tab

GET api/v4/lead-notes

Epic

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

Document status

Status
colourGreen
titleDRAFTREVIEWED

Document owner

Danny Hannah Adam Carter

Technical writers

Amish Ladhu

Related Content

https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/1131544585

...

  • The name of the campaign that the lead is captured on (especially helpful if viewing the lead in the global leads page where the campaign it was captured in is not immediately obvious). This is a link to the Campaign > overview page.

Generator

  • The name of the publisher that provided the lead (this item will not show if there is no lead generator)

...

  • The form used to capture the lead. This is a link to the form.

Entry Point

  • The source of the lead capture. It could show API information, or the landing page that the form was embeded embedded on.

...

‘Profile’ Tab

The profile tab shows all the values captured with the lead, plus any enrichment data or value transform data:

...

‘Publisher Data’ Panel

This panel shows all the values captured via form.

...

The below fields are shown by default in the table, however the values of these fields can be empty if not captured via the form (but the list item will still be shown on the table):

  • Title

  • First Name

  • Last Name

  • Telephone

  • Email

  • Channel

  • Address Line 1

  • Address Line 2

  • Address Line 3

  • Address Line 4

  • Postcode

The below fields are effectively metadata for the lead capture, and the relevant value is generated automatically without the need for these to the entered via the form:

  • Created Date

  • Created Year

  • Created Month

  • Lead Hash

Additional fields and their corresponding label, field name and value are included if they are captured on the data capture form, e.g. the ‘email domain’ item is shown if the ‘email’ is captured. If the email is not captured, the ‘email domain’ table item will not be shown.

If whitepapers are available on the campaign, related information, such as whitepaper id, category, subcategory etc. will be shown in this section, as shown below.

...

Additional Panels

Panels are automatically shown for enrichment where the data is generated depending on jobs added to the campaign, e.g:

...

Value transforms panels are also shown if these are configured on campaign, e.g:

...

'Associated Campaigns' Tab

This table shows any campaigns that the lead has also been captured on. The captured email address is used to determine an association.

...

‘Job Details’ Tab

This tab provides a breakdown of which the jobs that have been included on the campaign, and if those jobs have passed, failed or not run against the lead capture information.

If the job fails, the ‘message’ column provides information as to why the failure occurred, e.g.

...

‘Processr Logs’ Tab

This tab provides a breakdown of processr job tasks in chronological order, e.g:

...

‘Provider Logs’ Tab

This tab provides a breakdown of enrichment job tasks in chronological order, with the exact API message shown in the ‘Message’ column, e.g:

...

The user has the option to copy the message on to their clipboard using the ‘Copy’ button available against each entry.

‘Edit Data’ Tab

This tab allows the user to add new values to the lead, or edit existing values already captured with the lead.

...

To add a new value, complete the ‘New Fieldname’ and ‘New Value’ inputs, and then click the ‘Add' button.

...

To edit an existing value, click the ‘pen’ icon on the input in the ‘value’ column, then enter the new value and click the ‘save’ icon.

...

Field Name

Required

Notes

New Fieldname

(tick)

The fieldname that should be added as part of the lead capture information.

New Value

(tick)

The value of the field to be added.

‘Add’ button

(tick)

Once ‘New Fieldname’ and ‘New Value’ have been completed, the ‘Add’ button adds the value to the lead.

‘Notes’ Tab

This tab provides a breakdown of any lead status, delivery or contract changes.

...

\uD83D\uDDD2 Summary

Summarise the functionalities in a table

Functionality

User Story

1

Lead Profile

This panel provides an overview of the lead information, coupled with some enrichment features that are populated if certain fields are captured.

2

‘Profile’ Tab

The profile tab shows all the values captured with the lead, plus any enrichment data or value transform data.

3

‘Associated Campaigns’ Tab

This table shows any campaigns that the lead has also been captured on. The captured email address is used to determine an association.

4

'Job Details' Tab

This tab provides a breakdown of which the jobs that have been included on the campaign, and if those jobs have passed, failed or not run against the lead capture information.

5

'Processr Logs' Tab

This tab provides a breakdown of processr job tasks in time order.

6

‘Provider Logs’ Tab

This tab provides a breakdown of enrichment job tasks in time order, with the exact API message shown in the ‘Message’ column

7

‘Edit Data’ Tab

This tab allows the user to add new values to the lead, or edit existing values already captured with the lead.

8

‘Notes’ Tab

This tab provides a breakdown of any lead status, delivery or contract changes.

...

\uD83D\uDDD2 User Permissions

Admin users can access all the tabs. Agency users and advertiser users can view some tabs. PLease see user matrix for user permissions.

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

...