The Report Builder is our custom reporting solution, which allows you to build and schedule your own lead or campaign data reporting and send them via email or an FTP server.
With this report you will be able to customise whether you would like a lead or campaign data report, customise the fields you would like to collect and the conditions that need to be met for the report.
Please Note: The report builder can be accessed by Admin users and Agency users only. Agency users must have their data unmasked in order to view the data.
Building a Report
To get to the report builder, you will need to navigate to Reports > Report Builder on the left hand side of the platform.
1. To create a new report, click Add.
This will open a multi-step modal.
2. On the first page, you will be offered templates, as well as the option of what type of data you wish to pull.
You can either choose to build a report yourself, or make use of one of the templates. If you select a template, you will be shown a preview of the data that will be included in that report.
If you choose to build from scratch, then you will be asked what type of report you would like to pull.
- Lead: This will pull a report that is based on lead data - this includes all collected fields, as well as any Convertr data attributed to a lead
- Campaign: This is a higher level of data that will allow you to pull campaign data, including statistics related to them.
3. Once you have made your choice, you can move onto the next step, Set Up.
Here, you can set a name and description of your report. If you choose a template, this will be done already, but you can change it if you choose.
Beneath, you will be able to set your dates for the report.
You can either choose to specify dates, or select a rolling period.
- Specify Dates will offer a static option to input the dates that you'd like to cover in your report. You will need to select a start and end date.
- Rolling Period gives you the option to select a certain amount of time to pull leads from. In the above screenshot, it will pull data for the past 31 days from the date the report is generated.
Finally, at the bottom you can select permissions, apply a password and send as a zip file.
- Permissions: If set to Private, then this report setup will only be available to your user account. If set to Public, then another user can import this report into their own account, creating a copy.
- Password: You can password protect your XLSX report. If Send as Zip is disabled, we will password protect the XLSX file directly. If enabled, then we will apply the password to the ZIP folder.
- Send as Zip: If disabled, we will generate an XLSX file. If enabled, we will still do this but we will add it into a ZIP folder.
4. The next section is about the delivery of the report. You can choose how and when it is sent out.
You can choose to schedule this report to generate automatically by selecting Monthly, Weekly, or Daily. Depending on which you choose, you will be asked what day/time you want that to happen. If you do not set a schedule, then the report can be generated manually whenever you're in the platform.
For the Delivery Type, you have a few options:
- Download: This means the report will be generated for your user account, and has to be downloaded by logging into the platform and accessing your Exports.
- Email: This will email a direct link to download the file. You will be able to specify which email addresses should receive that link, and can add multiple emails by using a semi-colon separator.
- FTP/FTPS/SFTP: We can upload the file to a server of your choosing. You will need login credentials for the server you'd like to post to, and will be able to input them when selecting one of these options.
An example of the FTP requirements.
You can also choose whether your file compiles as an XLSX or a CSV file, depending on your requirements. If you select CSV, you will need to select the delimiter that is used as well. The delimiter determines how the data is separated in the file, with comma being the most common delimiter.
5. In the next section, you can define which fields you'd like to include in your report. If you select a template, this will be pre-filled but you can make edits if you would like.
To add a field to your report, select the checkbox next to it. You can use the Search box above the fields to look for a particular field.
Once you add a field, you have the option to change how it appears on the actual report, by amending the New Field Name.
The operator allows you to modify how a field is presented - it is designed to run in conjunction with grouping, and can allow you to generate reports that can count leads, sum up payout amounts and more.
In the screenshot example, there is a count on ID and a sum on publisher payout. This means we will be able to count the number of IDs (therefore counting the number of leads) and also perform a sum on the publisher payout for each lead. You can see how this works with grouping in the next step.
Finally, you can rearrange the fields by dragging and dropping them using the icon, or removed entirely using .
Please note: You can only have a maximum of 20 fields on your report.
6. On the conditions section, you can select criteria to determine which leads should be included in your report. At the moment you are required to have at least one condition.
You can apply a condition to most fields that are available in the fields section.
You can include AND/OR statements in this section, and also add groups if you'd like to apply these statements across multiple conditions.
To add a new condition, click Add Rule. To add a group, click Add Group. You will then be able to add rules to the group. A group will appear with a darker background.
Please note: You can have a maximum of 15 rules.
7. The next section is grouping. This tab is useful if you have used an operator in step 5. This allows you to roll up the data that you've applied operators to.
To add a group, use the search bar to find your chosen field, and click Add.
For example, in the above screenshot we have grouped by publisher and campaign ID. This means when we pull the count on lead ID and the sum of publisher payout, each row in the report will be for a single publisher on a single campaign.
This means that we will have a report that counts the number of leads and the total publisher payout per publisher and per campaign.
You can move the grouping order using , and remove using .
8. The last section, custom fields, allows you to append static columns to your report.
To add a static column, enter the column name into Column, and the value you want below it in Value. Then click Add.
This will append the column to the end of the report. In the above example, you will have a column called Client appended, and in every row of the report the value will be Convertr.
You can amend the order of your custom columns using , and remove using . Please note however that custom fields will always be at the end of your report.
Once you are happy with your report, hit Save to create it.
Generating and Editing a Report
You can generate a report builder report at any time by clicking Generate on the main Report Builder dashboard.
This will send the report to the delivery type that you specified, as well as deliver the report to you. You can access this report in the platform by navigating to your exports section at the top of the platform.
If you'd like to amend a report's configuration, then hit the Edit button to open the modal.
Importing a Report
You also have the ability to import another user's public reports. To do this, hit Import at the top of the Report Builder dashboard.
This will open a modal, where you can use the dropdown on the Report field to locate a report. You will need to know the name of the report you wish to import if you want a specific report from another user.
You will be asked to rename the report, then you can click Save and the report will appear in your list of reports.