Introduction
The below table outlines all the details on the Fields within the Convertr platform. This document is a living document and will contain the most up-to-date version of the values.
Field Name | Description | Data Set Type | Input | Data type | Max Character length | Accepted values | Accepts null value |
Campaign Start Ts | This is the campaign start date | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Campaign End Ts | This is the campaign end date | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Campaign Subcategory Name | This is the subcategory name | Lead | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Subcategory id | This is the subcategory id | Lead | System Generated | INT | 11 | TBC once platform is set up | No |
Campaign Category Name | This is the category name | Lead | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Category id | This is the category id | Lead | System Generated | INT | 11 | TBC once platform is set up | No |
Campaign Currency Name | This is the currency name | Lead | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Country Name | This is the campaign country | Lead | Text Input | VARCHAR | 255 | See tab Country List | No |
Campaign Country id | This is the country id | Lead | System Generated | INT | 11 | See tab Country List | No |
Convertr Campaign Name | This is the name of the campaign | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Convertr Campaign id | This is the campaign id | Lead | System Generated | INT | 11 | Free text field | No |
Account Manager | This is account manager | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Campaign Manager | This is the campaign manager | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Link Name | This is the link name | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Link Destination | This is the destination URL of the link | Lead | System Generated or Text Input | VARCHAR | 255 | Free text field | No |
Whitepaper Name | This is the name of the Whitepaper | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Whitepaper Categories | This is the category that the whitepaper is assinged to | Lead | System Generated | VARCHAR | 255 | TBC once platform is set up | No |
Whitepaper id | This is the System level Whitepaper id | Lead | System Generated | INT | 11 | System Generated | No |
Whitepaper Locale | This the locale of the whitepaper | Lead | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Whitepaper Subcategories | This the subcategory that the whitepaper is assigned to | Lead | System Generated | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Whitepaper Ref | This is the Campaign Whitepaper id | Lead | System Generated | INT | 11 | Yes | |
Whitepaper Tags | This iist of tags assigned to the whitepaper | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
Advertiser Payout | Ths is the advertiser payout value, this is calculated by the Total Contract Value for the campaign divided by the campaign Lead Volume | Lead | System Generated | DECIMAL | 10,2 | $$.$$ | No |
Publisher Payout | This is the publisher payout value | Lead | Text Input | DECIMAL | 10,2 | $$.$$ | No |
Advertiser Billable | This determines if the lead is advertiser billable | Lead | System Generated | BOOLEAN | 1 | Yes or No | No |
Publisher Billable | This determines if the lead is publisher billable | Lead | System Generated | BOOLEAN | 3 | Yes or No | No |
Publisher Contract Payout | This is the publisher contract payout assigned | Lead | System Generated | DECIMAL | 10,2 | $$.$$ | No |
Publisher Contract id | This is the id of the publisher contract issued | Lead | System Generated | INT | 11 | System Generated | No |
Publisher Contract Leads Required | This is the amount of leads allocated for a publisher on a campaign level | Lead | System Generated | INT | 255 | N/A | No |
Delivered | This is if the lead has a delivered status or not | Lead | System Generated | BOOLEAN | 3 | Yes, No | No |
Current Status | This is the overall status of the lead | Lead | System Generated | VARCHAR | 255 | Valid, Invalid, Caution, Test | No |
Original Status | This is the status in which the lead was originally in | Lead | System Generated | VARCHAR | 255 | Valid, Invalid, Caution | No |
2nd Check Status | This is the status of the lead after is has had a 2nd check status applied to it | Lead | System Generated | VARCHAR | 255 | Valid, Invalid, Test | No |
Form id | This is the id of the form | Lead | System Generated | INT | 11 | Free text field | |
Form Name | The is the name of the form | Lead | Text Input | VARCHAR | 255 | Free text field | |
Qa Flags | This will display all processr jobs that the lead failed on | Lead | System Generated | LONG VARCHAR | 32,700 | System Generated | Yes |
Lead Delivery Date | This is a combination of the Processr job id and date of when the lead was sent for to the processr for delivery, this will log everytime the lead is delivered. | Lead | System Generated | VARCHAR | 255 | [Campaign Processr Job id] YYYY-MM-DD HH:MM:SS | Yes |
2nd Check Flag Reason | The is the reason given as to why the lead was flagged as Valid, Invalid or Test | Lead | System Generated | VARCHAR | 255 | madeContact, confirmedDetails, confirmedInterest, lostInterest ,badNumber ,notSubmited, notProvided, returned, callbackRequested, unableToContact, testLead | Yes |
2nd Check Flag Comment | This is an addtional comment added as to why the lead was flagged as Valid, Invalid or Test | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
Job Delivery Time | This is a breakdown of the Integration Processr job, Integration Processr job label and executed timestamp (this can display mutiple) | Lead | System Generated | VARCHAR | 255 | Integration Processr Job name, Integration Processr Job label, executedTs | Yes |
First Delivered Date | This is the timestamp of when the lead was first marked as delivered | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Other Reason Type | This is meta data added to the lead used for reporting only | Lead | System Generated | VARCHAR | 255 | Replacement | Yes |
Other Reason Comment | This is meta data added to the lead used for reporting only | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
id | This is the Convertr Lead id | Lead | System Generated | INT | 11 | N/A | No |
Lead Hash | This is a unique hash for each lead | Lead | System Generated | VARCHAR | 255 | N/A | No |
Created Ts | This is the system timestamp of when the lead was created in the platform | Lead | System Generated | DATE | 20 | YYYY-MM-DD HH:MM:SS | No |
Created Date | This is the created date of when the lead was created in the platform | Lead | System Generated | DATE | 20 | YYYY-MM-DD | No |
Created Month | This is the created month of when the lead was created in the platform | Lead | System Generated | VARCHAR | 255 | JAN, FEB, MAR, APR, MAY, JUN, JUL, AUG, SEP, OCT, NOV, DEC | No |
Created Year | This is the created year of when the lead was created | Lead | System Generated | VARCHAR | 255 | YYYY | No |
Publisher id | This is the pubslisher id | Lead | System Generated | INT | 11 | TBC once platform is set up | No |
Publisher | This is the publisher name | Lead | Text Input | VARCHAR | 255 | Free text field | No |
Sub id | This is the sub id that can be passed in the Convertr tracking links | Lead | URL Input | VARCHAR | 255 | Free text field | Yes |
Title | This is a system default field for title | Lead | Form Input | LONGTEXT | N/A | Mr, Ms, Mrs, Miss, Dr, Rev | Yes |
First Name | This is a system default field for First Name | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Last Name | This is a system default field for Last Name | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Postcode | This is a system default field for postcode | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Advertiser | This is the name of the advertiser | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
Advertiser id | This is the advertiser id | Lead | System Generated | INT | 11 | TBC once platform is set up | Yes |
Address Line 1 | This is a system default field for address line 1 | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Address Line 2 | This is a system default field for address line 2 | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Address Line 3 | This is a system default field for address line 3 | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Address Line 4 | This is a system default field for address line 4 | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
This is a system default field for email | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes | |
Telephone | This is a system default field for telephone | Lead | Form Input | LONGTEXT | N/A | Free text field | Yes |
Opt in | This represent if the lead was opted in or not | Lead | Form Input | TINYINT | 1 | 1,0 | Yes |
Double Opt In | This represent if the lead was double opted in or not | Lead | Form Input | TINYINT | 1 | 1,1 | Yes |
Terms | This represent if the lead agreed to the terms | Lead | Form Input | TINYINT | 1 | 1,2 | Yes |
Contact Types | This represent how the lead would like to be contacted | Lead | Form Input | VARCHAR | 255 | Email, Tel, Post, SMS | Yes |
Over Allocation | This will state if a lead is in over allocation | Lead | System Generated | VARCHAR | 255 | publisher | Yes |
Fingerprint | This is a unique identifiyer | Lead | System Generated | VARCHAR | 255 | System Generated | No |
Integration | This states if the lead was integrated or not | Lead | System Generated | TINYINT | 1 | 1,0 | nNo |
Click id | This is the click id from the Convertr tacking link | Lead | System Generated | INT | 11 | System Generated | Yes |
Link id | This is the link id of the Convertr tracking link | Lead | System Generated | INT | 11 | System Generated | Yes |
Channel | This is the which the lead is associated with (determined by the tracking link) user can add own channels | Lead | Text Input | VARCHAR | 255 | Display, Text Link, Email, Social, Mobile, Search, API, Member Database, Network, Undisclosed Approved Inventory, Email Broadcast, Email Newsletter, Email Bulletin, Email Solus, SEM, SEO, PPC, Display - Internal Inventory, Display - Ad Exchange, Facebook Ads | Yes |
Roi | This will display the sales value against the lead | Lead | URL Input | DECIMAL | 10,2 | $$.$$ | Yes |
Contact Status | The is the Contract Status given to the lead for Call Centre enabled campaigns | Lead | System Generated | VARCHAR | 32 | Confirmed, Rejected, Unconfirmed | No |
Contact Attempt Number | The is the number of attemps logged to the lead for Call Centre enabled campaigns (this can be edited to increase the attempt count to more than 5) | Lead | System Generated | INT | 32 | 1, 2, 3, 4, 5 | Yes |
Contact Notes | The is the number of notes added the lead for Call Centre enabled campaigns | Lead | Text Input | LONGTEXT | N/A | Free text field | Yes |
Processr Status | The will show the processer status of the lead | Lead | System Generated | VARCHAR | N/A | Fair Usage Exceeded, On Hold - Pending Batch, On Hold - No Jobs Assigned, On Hold - Waiting for Connected Apps, On Hold - Campaign Using Scheduled Delivery, On Hold - Publisher Over Delivery, On Hold - Awaiting Value Transforms, On Hold - Awaiting Opt-in, Insufficient IO Allocation, Insufficient Credits, Awaiting Queue, Sent to Processr, Processing, Complete | No |
Additional Reference Number | This allows users to add an addtional reference to the campaign | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
Purchase Order | This allows users to add an purchase order to the campaign | Lead | Text Input | VARCHAR | 255 | Free text field | Yes |
Import Created By id | This is the user id from the person importing the lead file | Lead | System Generated | VARCHAR | 255 | System Generated | Yes |
Import Created By Username | This is the username from the person importing the lead file | Lead | System Generated | VARCHAR | 255 | System Generated | Yes |
Import File id | This is the import file id of the lead file updated | Lead | System Generated | VARCHAR | 255 | System Generated | Yes |
Import Filename | This is the import filename of the lead file updated | Lead | System Generated | VARCHAR | 255 | System Generated | Yes |
Email Domain | This is the Email Domian of teh lead submitted to the platform | Lead | System Generated | LONGTEXT | N/A | System Generated | Yes |
Returned Timestamp | This is the timestamp of when the lead was marked as Returned. | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | Yes |
Replaced Timestamp | This is the timestamp of when the lead was marked as Replaced. | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | Yes |
First Integration Date | This is a static timestamp of when the lead was first integrated (this will ignore the always-deliver configuration). | Lead | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Advertiser id | This is the name of the advertiser | Campaign | System Generated | INT | 11 | TBC once platform is set up | Yes |
Advertiser Name | This is the advertiser id | Campaign | Text Input | VARCHAR | 255 | Free text field | Yes |
Campaign id | This is the campaign id | Campaign | System Generated | INT | 11 | Free text field | No |
Campaign Name | This is the name of the campaign | Campaign | Text Input | VARCHAR | 255 | Free text field | No |
Publisher id | This is the pubslisher id | Campaign | System Generated | INT | 11 | TBC once platform is set up | No |
Publisher | This is the publisher name | Campaign | Text Input | VARCHAR | 255 | Free text field | No |
Band Name | This is the name of the publisher band | Campaign | Text Input | VARCHAR | 255 | Free text field | Yes |
Band id | This is the id of the Publisher Band | Campaign | System Generated | INT | 11 | System Generated | Yes |
Campaign Status | This is the current status of the campaign | Campaign | System Generated | VARCHAR | 20 | Active, Inactive, Ended, Setup Required, Paused | No |
Campaign Start Ts | This is the campaign start date | Campaign | System Generated | DATE | 20 | YYYY-MM-DD HH:MM:SS | No |
Campaign End Ts | This is the campaign end date | Campaign | System Generated | DATE | 20 | YYYY-MM-DD HH:MM:SS | No |
Account Manager | This is account manager | Campaign | Text Input | VARCHAR | 255 | Free text field | No |
Campaign Manager | This is the campaign manager | Campaign | Text Input | VARCHAR | 255 | Free text field | No |
Purchase Order | This allows users to add an addtional reference to the campaign | Campaign | Text Input | VARCHAR | 255 | Free text field | Yes |
Reference Number | This allows users to add an purchase order to the campaign | Campaign | Text Input | VARCHAR | 255 | Free text field | Yes |
Advertiser Payout | Ths is the advertiser payout value, this is calculated by the Total Contract Value for the campaign divided by the campaign Lead Volume | Campaign | System Generated | DECIMAL | 10,2 | $$.$$ | No |
Campaign Subcategory Name | This is the subcategory name | Campaign | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Subcategory id | This is the subcategory id | Campaign | System Generated | INT | 11 | TBC once platform is set up | No |
Campaign Category Name | This is the category name | Campaign | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Category id | This is the category id | Campaign | System Generated | INT | 11 | TBC once platform is set up | No |
Campaign Category Name | This is the category name | Campaign | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Currency Name | This is the currency name | Lead | Text Input | VARCHAR | 255 | TBC once platform is set up | No |
Campaign Currency id | This is the currency id | Campaign | System Generated | INT | 11 | TBC once platform is set up | No |
Campaign Country Name | This is the campaign country | Campaign | Text Input | VARCHAR | 255 | See tab Country List | No |
Campaign Country id | This is the country id | Campaign | System Generated | INT | 11 | See tab Country List | No |
Lead Earnings | Campaign | System Generated | DECIMAL | 10,2 | $$.$$ | Yes | |
Leads Remaining | This is the number of lead remaining on the campaign Total Lead Volume - Total Billable leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Leads Required | This is the total number of leads required to fullfill teh Total Lead Volume | Campaign | System Generated | INT | 11 | System Generated | Yes |
Billable Leads | This is the total number of billable leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Caution Leads | This is the total number of caution leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Invalid Leads | This is the total number of invalid leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Valid Leads | This is the total number of valid leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Delivered Leads | This is the total number of delivered leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Replacement Lead | This is the total number of replacement leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Returned Leads | This is the total number of returned leads | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Leads Required | This is the total number of publisher leads required | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Billable Total | This is the total number of leads that are billable for the publisher | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Earnings | This is the total publisher earnings (revenue) | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher CurrentCPL | This is the current CPL for the publisher | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Current Leads Remaining | This is the current number of leads remaining for the publisher | Campaign | System Generated | INT | 11 | System Generated | Yes |
Campaign Overdelivery | This is the total number of leads that are over campaign allocation | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Overdelivery | This is the total number of leads that have been held for publsher over delivery | Campaign | System Generated | INT | 11 | System Generated | Yes |
Contact Status Confirmed | The total number of leads that has a contact status of Confirmed | Campaign | System Generated | INT | 11 | System Generated | Yes |
Contact Status Rejected | The total number of leads that has a contact status of Rejected | Campaign | System Generated | INT | 11 | System Generated | Yes |
Contact Status Unconfirmed | The total number of leads that has a contact status of Unconfirmed | Campaign | System Generated | INT | 11 | System Generated | Yes |
Revenue Remaining | This is the total revenue reaming | Campaign | System Generated | INT | 11 | System Generated | Yes |
Publisher Percentage Allocated | % of the total leads allocated to publisher compared to the campaign cap | Campaign | System Generated | VARCHAR | 255 | System Generated | Yes |
Total Campaign Value | This is the overall value of the campaign, the calculation is Lead Volume Required x Advertiser CPL (For uncapped campaigns, this will display N/A) | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Total Publisher Revenue | This is the running revenue total of the publisher revenue generated. The calculation is Publisher Billable leads x Publisher CPL | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Percentage Remaining | Percentage remaining which is calculated as:(Total Volume - Billable (Delivered))/ Total*100% (For uncapped campaigns, this will be displayed as N/A) | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Total Revenue Remaining | Total Revenue Remaining is calculated as: Advertiser CPL x (Total Lead Volume - Billable leads) (This is N/A for uncapped campaigns) | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Margin Calculation | This is the margin of Number of leads x revenue amount vs number of leads x cost ,This is calculated as: (Total Advertiser Billable x Advertiser CPL) - (Total Publisher Billable x Publisher CPL) | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Campaign | VARCHAR | 255 | System Generated | No | |||
Time Remaining (Days) | Time Remaining (Days) which is calculated as: Current Date - Campaign End Date - in days rounded up. | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
First Activity Timestamp | This is a date timestamp of first billable lead on the campaign | Campaign | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Campaign Creation Date | This is the timestamp when the campaign was originally created: | Campaign | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Publisher Assignment Date | This is the date in which a Publisher was first added to campaign and signed their publisher contract | Campaign | System Generated | DATETIME | N/A | YYYY-MM-DD HH:MM:SS | No |
Total Actual Revenue | This is the running revenue total for the campaign. calculation is: Advertiser Billable Lead Total x Advertiser CPL | Campaign | System Generated | VARCHAR | 255 | System Generated | No |
Total Delivered Leads | This is the running total of all leads delivered for the campaign | Campaign | System Generated | VARCHAR | 255 | System Generated | Yes |
Billable Leads | Introduce new field Billable Leads. This is the number of billable leads for a given time period in the campaign | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Valid Leads | This is the running total of all Valid leads in the campaign | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Invalid Leads | This is the running total of all Invalid leads in the campaign | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Caution Leads | This is the running total of all Caution leads in the campaign | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Returned Leads | This will give the running total of leads that have been flagged as invalid with a reason of Returned | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Replaced Leads | This will give the running total of leads that have been flagged as Other and Replaced | Campaign | System Generated | INT | 11 | System Generated | Yes |
Total Publisher Leads Delivered | This will be a running total of the delivered leads that the publisher has generated | Campaign | System Generated | INT | 11 | System Generated | Yes |
Campaign Percentage Allocated | This will be calculated as the percentage of leads in the campaign that are allocated to publishers. E.g. calculation Leads required for a campaign: 100 No. of leads allocated to Publisher P1= 25 No. of leads allocated to Publisher P2= 30 Total leads allocated = 25+30 => 55/100 Campaign Percentage Allocated is therefore 55% |
Campaign | System Generated | VARCHAR | 255 | System Generated | Yes |