Platform URL | https://[enterprise].cvtr.io/v2/leads | ||||||||
|---|---|---|---|---|---|---|---|---|---|
API Endpoints | Load Campaign dropdown GET Load Campaign data fields GET Load lead data fields GET Load list of advertisers GET Load list of publishers GET Load/Delete user template GET/api/v4/user-export-maps/[ID] Delete user template DELETE Create user template POST Lead Export POST | ||||||||
Epic |
| ||||||||
Document status |
| ||||||||
Document owner | |||||||||
Technical writers | |||||||||
Related Content | https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/1131544585 |
...
From the Leads page which is available to users (refer User Permission section below), users will be able to export leads at a Global level for the enterprise by clicking on the Export button.
...
Global Leads Export is a 3 step process, as described below.
Step 1: Setup
On click of the Export button, it opens a Lead Export modal popup where user could can add filter criteria for the Leads that needs to be exported. This is the Setup step.
...
User could select the radio button option of All advertisers & All Publishers and then can choose to generate the report for ‘All advertisers’ or a ‘Single Advertiser’ and for ‘All Publishers’ or for a ‘Single Publisher’ by selecting the appropriate radio button.
User can then enter a date range to export all leads within the date range. If the user wants to filter out leads for just a campaign, the campaign dropdown could can be used, where it shows a list of campaigns.
...
If the user wants the file to be exported as a CSV file, the CSV export toggle will could should be enabled. Else , else the file will be available for download as an Excel file .
...
by default.
Clicking on the ‘Next’ button takes the user to the second step: ‘Columns’.
Step 2: Columns
In the Columns section of the Lead Export Modal, user can select the columns that need to be added available in the exported file. User can load or delete any pre-existing column template selection using the Column Template dropdown.Using the Search fields . The user can select columns and save the template as a new template using the ‘Save as new template’ option and giving a unique name to the template.
| View file | ||
|---|---|---|
|
The user can also load previously saved templates using the ‘Column Template’ dropdown and clicking on ‘Load’. This will populate the Output Columns with the columns in the saved template. The user can also delete any saved templates by loading the template and clicking on ‘Delete’
...
Using the ‘Search Fields’ search bar, user can search for a column that needs to be added in the report. Columns for the report are categorised and can be viewed by expanding the accordion menu.
...
Once the user selects a column, the column is added in to the Output Columns‘Output Columns’, where the user could can re-arrange them and add a new Filed name provide a ‘New Field Name’ if needed.
...
The Save ‘Save Column Template Template’ option allows the user to save the current selection as a template and re-use the same in the future.
Clicking on ‘Next’ takes the user to the final step of lead export: ‘Conditions’
Step 3: Conditions
In the Conditions section ‘Conditions’ step of the Lead Export Modal, user could can select the a Lead Statuses Status that needs to be filtered out for the Lead Export Report.
...
The different types of Lead status are Delivered, Valid, Invalid, Caution,Test, Billable & All. Once The user can select only 1 of the lead status.
Finally, when the user clicks on Export the ‘Export’ button, the Lead Export report is generated and will be available in the Export Requests ‘Exports’ section .
...
in the banner.
...
The report generated will be available under ‘New’ tab, from where the user can download the report. Once downloaded, the report moves to the ‘Downloaded’ tab from where the report can be downloaded, if required, in the future.
...
\uD83D\uDDD2 Summary
Functionality | User Story | |
|---|---|---|
| 1 | Lead Export modal: Setup | User could select the radio button option of All advertisers & All Publishers and then a date range to export all leads within the date range. If the user wants to filter out leads for just a campaign, the campaign dropdown could be used where it shows a list campaignsAdmin and agency users can specify the date range, advertisers, publishers and campaigns for which the leads must be exported. |
| 2 | CSV ExportIf | the user wants the file to be exported as a CSV file, the CSV export toggle will could be enabled. Else the file will be available for download as an Excel fileAdmin and Agency users can choose to export the report in CSV format by enabling a toggle, else the report will be downloaded as an excel. |
| 3 | Lead Export modal: Columns sectionIn the Columns section of the Lead Export Modal, user | Admin and agency users can select the columns that need to be added in the exported file |
| 4 | Save Column Template | Allows the user to save the current selection as a template and re-use the same in the future. |
| 5 | Conditions | In the Conditions section of Lead Export Modal, user could select the Lead Statuses appear in the report. User can create a new template, load previously saved templates and delete templates in this step. |
| 4 | Lead Export modal: Conditions | Admin and Agency users can select the Lead Status that needs to be filtered out for in the Lead Export Report. |
\uD83D\uDDD2 User Permissions
Admin and agency users can perform global lead export.
...