This section allows for the creation of three types of report schedules:
-
Immediate one time reporting jobs
-
Scheduled one time reporting jobs
-
Recurring scheduled reporting jobs
Reports can be scheduled to be retrieved using the following methods:
-
Downloaded directly from the Interface
-
Sent via email and download from the email
-
Through a Callback URL
-
Transported to a FTP server
To access the reporting section Super Admins can navigate to the Report section and click on Reporting Jobs.
From here you will be able to see All past jobs that have run as well as scheduled jobs. If you want to see just scheduled jobs you can navigate to that tab. On the scheduled jobs tab you can view jobs notes and info on the job as well as cancel jobs that haven't started.
It is important to note that you can view up to 60 days of data on the reports that you pull from this section. We are looking to expand this data range as the move out of beta.
To schedule a new reporting jobs you will select the New Request tab. From that section you will select the:
New Request
-
Job Type
-
Secondary Select
-
Type of File - CSV or JSON - Optional to compress records to reduce the file size.
-
Enable and select the notification types
-
Enable and select to Schedule the job
-
Enable and select to Transport the data to an FTP server
The following reports are included in the select for the job type:
-
List Download
-
DNC Report
-
Suppression Report
-
Export Report
-
Call Recording Report
-
List Conversion Report
Once you select the job type report you will see secondary data to fill out. This includes options of custom records, per campaign, all numbers, etc.
Once the secondary data is filled out you will want to select the type of data file. The current options are as a CSV record or JSON file. There is an additional option for compressing the file as well.
Next you will want to select the Notification types you would like to receive. The current options include:
-
Email
-
Callback URL
An example of the callback payload will look like the following:
{ "job_id": "5379", "job_name": "Recording Log", "job_description": "Recording Log desc", "updated_date": "2021-09-20 16:53:59", "storage_url": "https://storage.googleapis.com/x5-clients/apple-tree/reports/pinecone/pumpkinsice.json" }
Following that you will review the report schedule. To immediately send the report leave this section disabled. To schedule a report enabled this section and you will be presented with a number of options.
First off you can add jobs notes. These notes are for internal use and will only show in the interface for a reminder about why data was pulled or scheduled. The first option is to select the exact date and time you want to execute the report for a one time scheduled report. That report time is based off of your selected time zone.
To schedule a recurring report you will select one of three options:
-
Frequently used triggers
-
Custom
-
Every 1 hour
Frequently used triggers are a selection of recurring report timeframes that we see are commonly used.
Custom reporting is an expanded option that allows you to select any cadence you need for your reporting schedule.
Every hour is a recurring schedule for quick use to send reporting data for a report out every hour.
The last option to review and select is Transport. When enabled this selection allows you to select a Transport options from your transport section. The commonly allows you to send data out to a FTP server.
To add a transport route a Super Admin would proceed to the Settings section and select Transports. Here you have the options of selecting from sftp and ftp. For both of these types you will need to know your server host name and port. Once a transport is set up you will be able to use it in reporting.