Reporting
The reporting solution within the focus portal allows users to run reports for offline analysis or audit. The portal support both adhoc reports or schedule a report to run at a regular time.
Running reportsβ
Load the reporting screens within the focus portal by selecting Admin followed by Reports:
The reports home page will show a list of any previously run reports and the status of that report.
- Filter for any currently scheduled or completed reports
- Switch between Adhoc and Scheduled reports
- Run a new report or schedule a report to run
Depending on the report you are trying to run different options will show (see Available Reports for a list of reports and all the input options)
- Select the report you would like to run
- Complete any parameters that are needed for this report. Mandatory parameters are marked with a star (*)
- Run the report
Available Reportsβ
Communications Extractβ
This report outlines the conversations that have happened between a specific date range, it will show all conversations during that time range from any type or input. Optional you can add a specific conversation type (e.g. Teams calls) or a specific staff member to create a custom report.
Type: Adhoc
Report Inputs
- Start Date Time
- End Date Time
- Communication Type (optional)
- Staff member (optional)
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Ref | Integer | 11223344 | The unique reference for the communication |
Type | String | Phone | The communication type |
Start Date UTC | DateTime | 2024-11-01 09:01:00 | The start date of the communication |
End Date UTC | DateTime | 2024-11-01 09:02:00 | The end date of the communication |
Duration | Time | 5:33 | The length of the communication |
Direction | String | Inbound | The direction of the communication from the recorded user's point of view |
Staff Name | String | James Smith | The name (if available) of the staff member |
Staff Endpoint | String | +44123321123 | The endpoint of the staff member |
Third Party Name | String | Adam Jones | The name (if available) of the third party |
Third Party Endpoint | String | +1234987987 | The endpoint of the third party |
Groups | String | London, Sales team | A list of any groups the staff member is in |
Expires Date UTC | DateTime | 2028-11-01 09:02:00 | The date and time the call will expire (Note: if on local hold this will be infinite) |
Legal Holds | String | Case 112, James and Steve | A list of any legal holds the call is in |
Hang up Party | String | Staff | Which side finished the communication |
Failure Reason | String | No answer | The reason the communication failed (if available) |
AI Tags Usage Reportβ
This report show the number of tags being identified by the AI service over the time period requested grouped by each day.
Type: Adhoc
Report Inputs
- Start Datetime
- End Datetime
- Communication Type (optional)
- Staff member (optional)
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Date | Date | 2024-11-01 | The date of the communication |
Tag Name | String | 11223344 | The unique reference for the communication |
Tag Type | String | Phone | The communication type |
Count | Integer | 100 | The number of times that tag has been used |
Legal Holds Extractβ
This report shows all conversations that have one or more legal holds against that conversation. Optional you can add a specific legal hold reason to download a list of just that legal holds conversations.
Type: Adhoc
Report Inputs
- Legal hold reason (optional)
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Ref | Integer | 11223344 | The unique reference for the communication |
Type | String | Phone | The communication type |
Start Date UTC | DateTime | 2024-11-01 09:01:00 | The start date of the call |
End Date UTC | DateTime | 2024-11-01 09:02:00 | The end date of the call |
Duration | Time | 5:33 | The length of the call |
Direction | String | Inbound | The direction of the call from the recorded user's point of view |
Staff Name | String | James Smith | The name (if available) of the staff member |
Staff Endpoint | String | +44123321123 | The endpoint of the staff member |
Third Party Name | String | Adam Jones | The name (if available) of the third party |
Third Party Endpoint | String | +1234987987 | The endpoint of the third party |
Groups | String | London, Sales team | A list of any groups the staff member is in |
Legal Holds | String | Case 112, James and Steve | A list of any legal holds the call is in |
Portal Usersβ
This report shows all users in the portal and when they last used the system. This data is supplied for audit reasons.
Type: Adhoc
Report Inputs
- Include inactive users
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Ref | String | dsdsd2asdas | The unique reference for the user in the system |
String | user@domain.com | The email address in the system | |
Name | String | Test User | The person's name |
Policy | String | Super User | The policy the person is currently assigned with |
Status | String | Active | The status of the user |
Login Method | String | Local | The method the user logs into the portal with e.g. SSO or Local login |
Last login UTC | DateTime | 2024-11-01 09:02:00 | The last time the user logged into the system |
Groups assigned | String | Sales team, London | Any group the user is allowed to see communications for |
Endpoints Reportβ
This report shows all provisioned endpoints for all communication types within the account. Optional values of "communication type" can be supplied to only receive a list of specific endpoints e.g. MS Teams endpoints, only currently provisioned endpoints will be shown if the "Show only active endpoints" tickbox is selected and only recorded endpoints shown if "Show only active endpoints" is selected.
Type: Adhoc
Report Inputs
- Communication type (optional)
- Show only recorded endpoints (optional)
- Show only active endpoints (optional)
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Ref | String | 12333221 | The unique reference for the endpoint |
Endpoint | String | +44788833374 | The value of the endpoint |
Type | String | Phone | The endpoint type |
Is Recorded | Boolean | True | Is the endpoint recorded |
Is Provisioned | Boolean | True | Is the endpoint current provisioned |
Status | String | Active | The status of the endpoint |
Associated person | String | James Smith | The person, if any this endpoint is associated with |
Last communication UTC | DateTime | 2024-11-01 09:02:00 | The last time this endpoint made or received a communication |
Last provisioning UTC | DateTime | 2024-11-01 09:02:00 | The last time this endpoint was provisioned |
Service Code | String | AABBCC | The endpoint service code, if supplied during provisioning |
SMS to Email Reconciliation Reportβ
This report provides the details of all SMS messages sent out via email if enabled on your account.
Type: Adhoc Scheduled
Details
Report Inputs
Adhoc:- Start Datetime
- End Datetime Scheduled:
- The report will run for the day before midnight to midnight
Report Definition
Heading | Datatype | Example | Description |
---|---|---|---|
Ref | String | 12333221 | The unique reference for the communication |
Endpoint | String | +44788833374 | The endpoint the SMS was received on |
Email sent UTC | DateTime | 2024-11-01 09:02:00 | The time the email was sent in UTC |
Error message | String | Email address not valid | Any error message at the time of sending |