Export Leads
- Arunima Kurup Prasad
Platform URL | https://[enterprise].cvtr.io/v2/campaigns/{campaignI}/leads |
|---|---|
API Endpoints | Load Campaign data fields GET Load lead data fields GET Load/Delete/Create user template GET/DELETE/POST Load processr jobs on the campaign GET Load list of publishers on campaign GET Lead Export POST |
Epic | |
Document status | DRAFT |
Document owner | @Danny Hannah @Adam Carter |
Technical writers | @Arunima Kurup Prasad @Vijay Alexander |
Related Content | https://convertr.atlassian.net/wiki/spaces/PF/pages/edit-v2/1131544585 |
Feature Overview
On the Campaign > Leads page which is available to users (refer User Permission section below), users can export leads at a Campaign level by clicking on the Export button.
Exporting Campaign Leads is a 2/3 step process, as described below.
Step 1: Setup
On click of the Export button, it opens a Lead Export modal popup where the user can add filter criteria for the Leads that needs to be exported. This is the Setup step.
Since a campaign has only a single advertiser, the ‘All Advertisers' radio button is selected by default and the advertiser name is pre populated on load and the user cannot change this.
The user can choose to generate the report for ‘All Publishers’ on the campaign or for a ‘Single Publisher’ by selecting the appropriate radio button and selecting the name of the publisher from the dropdown, if ‘Single Publisher’ is selected.
The date range is auto populated to reflect the campaign start and end date. Since lead export can be done only for a period of 365 days (or 366 days for leap year), the user must ensure that the date range matches this criteria.
If the user wants the file to be exported as a CSV file, the CSV export toggle should be enabled, else the file will be available for download as an Excel file by default.
The user can select ‘All Columns’ or ‘Specify Columns' option under ‘Columns’.
If the user selects, ‘All Columns’, the generated report will contain all columns and clicking on the ‘Next’ button will take the user to the last step: ‘Conditions’.
If the user selects, ‘Specify Columns’, clicking on the ‘Next’ button will take the user to the second step: ‘Conditions’.
This determines if campaign lead export is a 2 step or 3 step process.
Step 2: Columns
In the Columns section of the Lead Export Modal, user can select the columns that need to be available in the exported file. 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.
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 to the ‘Output Columns’, where the user can re-arrange them and provide a ‘New Field Name’ if needed.
Clicking on ‘Next’ takes the user to the final step of lead export: ‘Conditions’
Step 3: Conditions
In the ‘Conditions’ step of the Lead Export Modal, user must select a Lead Status that needs to be filtered out for the Lead Export Report. The Lead statuses available to select differs for each user role (please refer the user matrix attached below for details). The user can select only 1 of the lead status. The user may also filter out processr jobs on the campaign from the ‘Flag Filter’ dropdown.
After selecting a job from the dropdown, the user must click on the ‘Add’ button to add it as a condition. The selected jobs will be listed as a table, as shown below.
Additionally, the user can select the status of the job to be filtered on- whether to export leads that ‘passed’ the job or ‘failed’ the job. The user can also remove the job filter by clicking the ‘Remove’ button available against each job.
Finally, when the user clicks on the ‘Export’ button, the Lead Export report is generated and will be available in the ‘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.
Summary
Functionality | User Story | |
|---|---|---|
| 1 | Lead Export modal: Setup | Users can specify the date range, publishers for which the leads must be exported. Advertiser is auto populated. User can choose if they want to export all columns or specify the columns in the report. |
| 2 | CSV Export | 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 | If user selects ‘All Columns’ in setup, this step will be skipped. If the user selects 'Specify Columns', they can select the columns that need to 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 | Users must select the Lead Status that needs to be filtered out in the Lead Export Report. They may also select processr jobs that the leads passed or failed against. |
User Permissions
All users except call centre operators and creative managers can perform lead export at a campaign level. However, the lead status available to each user role varies and access to Export button depends on certain configurations. Please refer below user matrix for details.