Reports Overview on ~.UcClient.~ Unified Communications

Get All Reports

Mon, 01 Jan 0001 00:00:00 +0000

Get All Reports #

Gets a list of all reports configured in a specific workspace. Once a list of all reports has been retrieved, it can be execute and data retrieved using a specific reportId.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports

Example #

This request will get a list of all reports configured within the specified workspace.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports> HTTP/1.1
Authorisation: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
	"page_size": 3,
    "page_index": 0,
    "data": [{
            "id": "00000000-0000-0000-0000-000000000001",
            "name": "Call List (Segmented)"
        }, {
            "id": "00000000-0000-0000-0000-000000000002",
            "name": "Calls by Queue Name"
        }, {
            "id": "00000000-0000-0000-0000-000000000003",
            "name": "Calls by User"
        }
    ][{
            "id": "00000000-0000-0000-0000-000000000001",
            "name": "Call List (Segmented)"
        }, {
            "id": "00000000-0000-0000-0000-000000000002",
            "name": "Calls by Queue Name"
        }, {
            "id": "00000000-0000-0000-0000-000000000003",
            "name": "Calls by User"
        }
    ],
	"status": "success",
	"timestamp": "2019-05-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised

Post Report Request

Mon, 01 Jan 0001 00:00:00 +0000

Post Report Request #

Post a request to run a report for a specific time period (dateFilter).

POST /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/requests

Example using a Preset Date Filter #

This request will run a report for the current quarter. The return body contains as 'requestId' which can be used to query the status of the report and retrieve the dataset.

Request #

POST <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/requests> HTTP/1.1
Content-Type: application/json
Authorisation: Bearer {TOKEN}
Connection: keep-alive
{
    "reportId": "00000000-0000-0000-0000-000000000001",
    "filterId": "00000000-0000-0000-0000-000000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "additionalConditions" : \[]

}

info
The 'presetName' can be any one of the valid Preset Date Filters.

info
The 'filterId' can be used to apply a pre-defined filter to the report. If not supplied, the default filter applied to the report being requested will be used.

info
The 'additionalConditions' can be used to apply Additional Filters to the report. These filters will supplement whatever parameters are specified in a pre-defined filter.

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
    "data": {
        "requestId": "00000000-0000-0000-0000-000000000005",
        "locale": "en-GB",
        "reportId": "00000000-0000-0000-0000-000000000001",
        "referenceDate": "2025-09-22T15:23:01.0201791+00:00",
        "dateFilter": {
            "presetName": "ThisQuarter",
            "presetFilterObject": {
                "units": 5,
                "offset": 0,
                "length": 1,
                "roundingMode": 1,
                "daysOfWeek": 127
            },
            "daysOfWeek": 127
        },
        "startTime": "2025-07-01T00:00:00+01:00",
        "endTime": "2025-09-22T16:08:01.02159+01:00"
    },
    "status": "success",
    "timestamp": "2025-09-22T15:23:02.2982477Z"
}

Example using a Fixed Date Range #

This request will run a report for the current quarter. The return body contains as 'requestId' which can be used to query the status of the report and retrieve the dataset.

Get Status

Mon, 01 Jan 0001 00:00:00 +0000

Get Status #

This request accepts a report 'requestId' and returns the status of the request.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}

Example - In Progress Request #

This request returns the status of a report request that is still running.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005> HTTP/1.1
Authorization: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
    "data": {
        "dateCreated": "2025-09-22T15:27:40.1946146Z",
        "tenantId": "f8322e65-ddac-4f5c-1f6c-08db2fa7b464",
        "requestId": "65224fa5-f4c6-4796-b3c8-c4f67d504971",
        "reportId": "2aafb829-91aa-4d17-a5d3-bb6fde34ca10",
        "status": "Complete",
        "statusMessage": "Report processing complete",
        "reportTemplateName": "CallListByUserSegmented"
    },
	"status": "success",
	"timestamp": "2019-05-01T10:00:00.2890319Z"
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised

Get Results

Mon, 01 Jan 0001 00:00:00 +0000

Get Results #

This request accepts a report 'requestId' and returns the results of the report if complete.

GET /v1.0/workspaces/{WORKSPACE_ID}/reports/{REPORT_ID}/results/{REQUEST_ID}/data

Example #

This request returns the result data of a report request that is complete.

Request #

GET <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports/00000000-0000-0000-0000-000000000001/results/00000000-0000-0000-0000-000000000005/data> HTTP/1.1
Authorization: Bearer {TOKEN}

Response #

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Content-Length: xx
{
    "requestId": "00000000-0000-0000-0000-000000000005",
    "tenantId": "00000000-0000-0000-0000-000000000000",
    "request": {
        "requestId": "00000000-0000-0000-0000-000000000005",
        "dateCreated": "2025-09-22T15:27:40.1946146Z",
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "reportId": "00000000-0000-0000-0000-000000000001",
        "reportTemplateName": "CallListByUserSegmented",
        "filterConditions": \[
            {
                "fieldName": "start",
                "operator": ">=",
                "values": ["2025-01-01T00:00:00.0000000+00:00"][
                    "2025-01-01T00:00:00.0000000+00:00"
                ]
            },
            {
                "fieldName": "end",
                "operator": "\<",
                "values": ["2025-09-22T15:12:40.1423517+00:00"][
                    "2025-09-22T15:12:40.1423517+00:00"
                ]
            }
        ],
        "sortFields": [
            {
                "fieldName": "start",
                "direction": 1
            }
        ][
            {
                "fieldName": "start",
                "direction": 1
            }
        ],
        "displayFields": [
            {
                "fieldName": "connId",
                "mandatory": false
            },
            {
                "fieldName": "start",
                "mandatory": false
            },
            {
                "fieldName": "userName",
                "mandatory": false
            },
            {
                "fieldName": "userNum",
                "mandatory": false
            },
            {
                "fieldName": "cli",
                "mandatory": false
            },
            {
                "fieldName": "cliName",
                "mandatory": false
            },
            {
                "fieldName": "hgNum",
                "mandatory": false
            },
            {
                "fieldName": "callType",
                "mandatory": false
            },
            {
                "fieldName": "callDir",
                "mandatory": false
            },
            {
                "fieldName": "ans",
                "mandatory": false
            },
            {
                "fieldName": "ref",
                "mandatory": false
            },
            {
                "fieldName": "lost",
                "mandatory": false
            },
            {
                "fieldName": "ring",
                "mandatory": false
            },
            {
                "fieldName": "duration",
                "mandatory": false
            },
            {
                "fieldName": "calledUserNum",
                "mandatory": false
            },
            {
                "fieldName": "calledUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserNum",
                "mandatory": false
            },
            {
                "fieldName": "hgName",
                "mandatory": false
            }
        ][
            {
                "fieldName": "connId",
                "mandatory": false
            },
            {
                "fieldName": "start",
                "mandatory": false
            },
            {
                "fieldName": "userName",
                "mandatory": false
            },
            {
                "fieldName": "userNum",
                "mandatory": false
            },
            {
                "fieldName": "cli",
                "mandatory": false
            },
            {
                "fieldName": "cliName",
                "mandatory": false
            },
            {
                "fieldName": "hgNum",
                "mandatory": false
            },
            {
                "fieldName": "callType",
                "mandatory": false
            },
            {
                "fieldName": "callDir",
                "mandatory": false
            },
            {
                "fieldName": "ans",
                "mandatory": false
            },
            {
                "fieldName": "ref",
                "mandatory": false
            },
            {
                "fieldName": "lost",
                "mandatory": false
            },
            {
                "fieldName": "ring",
                "mandatory": false
            },
            {
                "fieldName": "duration",
                "mandatory": false
            },
            {
                "fieldName": "calledUserNum",
                "mandatory": false
            },
            {
                "fieldName": "calledUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserName",
                "mandatory": false
            },
            {
                "fieldName": "callUserNum",
                "mandatory": false
            },
            {
                "fieldName": "hgName",
                "mandatory": false
            }
        ],
        "childDisplayFields": \[],
        "ignoreDisplayFields": false,
        "metadata": {
            "reportName": null,
            "dateFilter": {
                "presetName": "ThisYear",
                "presetFilterObject": {
                    "units": 6,
                    "offset": 0,
                    "length": 1,
                    "roundingMode": 1,
                    "daysOfWeek": 127
                },
                "daysOfWeek": 127
            },
            "referenceDate": "2025-09-22T15:27:40.1423161+00:00",
            "timeZoneReferenceDate": "2025-09-22T16:27:40",
            "filterId": null,
            "additionalFilters": \[],
            "workspaceFilterId": null,
            "timezoneDateFrom": "2025-01-01T00:00:00",
            "timezoneDateTo": "2025-09-22T16:12:40",
            "timeZoneDateCreated": "2025-09-22T15:27:40.1423517+00:00",
            "timeZoneAbbreviation": "BST"
        },
        "source": "api.onboarding",
        "pageSize": -1,
        "batchSize": -1,
        "rowLimit": 1000000,
        "priorityLevel": 2,
        "callRatePeriod": 120,
        "ignoreAbandonedCalls": false,
        "ignoreShortAnsweredCalls": false,
        "accountCodeLabels": {},
        "ringDurationThresholds": [
            10,
            20,
            30,
            40,
            50,
            60,
            70,
            80,
            90,
            100,
            110,
            120,
            120
        ][
            10,
            20,
            30,
            40,
            50,
            60,
            70,
            80,
            90,
            100,
            110,
            120,
            120
        ],
        "incomingEstimatedRevenue": 100.0,
        "incomingCallsPerSale": 5,
        "outgoingEstimatedRevenue": 100.0,
        "outgoingCallsPerSale": 5,
        "durationGroupPeriodInSeconds": 10,
        "timeZoneId": "Europe/London",
        "countryCode": "GB",
        "locale": "en-GB",
        "totalTrunks": 10,
        "maxRows": 0
    },
    "effort": 210.17,
    "queryDuration": 2076,
    "totalDuration": 2121,
    "queryCount": 2053,
    "rowLimitExceeded": false,
    "totalCount": 922,
    "data": [
        {
            "connId": "00000000-0000-0000-0000-000000000001",
            "start": "2025-09-18T11:16:31",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "hgNum": "200",
            "callType": 2,
            "callDir": 2,
            "ring": 1.0,
            "duration": 1.0,
            "calledUserNum": "+19876543210",
            "calledUserName": "Unknown",
            "callUserNum": "+11234567890",
            "hgName": "Queue 200",
            "docId": "00000000-0000-0000-0000-000000000009"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000002",
            "start": "2025-09-18T11:16:13",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "callType": 2,
            "callDir": 3,
            "ans": 1,
            "ring": 5.0,
            "duration": 6.0,
            "calledUserNum": "+19876543210",
            "callUserName": Test User 1",
            "callUserNum": "101",
            "docId": "00000000-0000-0000-0000-000000000010"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000003",
            "start": "2025-01-03T16:44:40",
            "userName": "Test User 2",
            "userNum": "102",
            "callType": 1,
            "callDir": 2,
            "ans": 1,
            "ring": 0.0,
            "duration": 498.0,
            "calledUserNum": "00000000-0000-0000-0000-000000000012",
            "calledUserName": "Test User 2",
            "docId": "00000000-0000-0000-0000-000000000011"
        }
    ][
        {
            "connId": "00000000-0000-0000-0000-000000000001",
            "start": "2025-09-18T11:16:31",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "hgNum": "200",
            "callType": 2,
            "callDir": 2,
            "ring": 1.0,
            "duration": 1.0,
            "calledUserNum": "+19876543210",
            "calledUserName": "Unknown",
            "callUserNum": "+11234567890",
            "hgName": "Queue 200",
            "docId": "00000000-0000-0000-0000-000000000009"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000002",
            "start": "2025-09-18T11:16:13",
            "userName": "Test User 1",
            "userNum": "101",
            "cli": "+11234567890",
            "cliName": "",
            "callType": 2,
            "callDir": 3,
            "ans": 1,
            "ring": 5.0,
            "duration": 6.0,
            "calledUserNum": "+19876543210",
            "callUserName": Test User 1",
            "callUserNum": "101",
            "docId": "00000000-0000-0000-0000-000000000010"
        },
        {
            "connId": "00000000-0000-0000-0000-000000000003",
            "start": "2025-01-03T16:44:40",
            "userName": "Test User 2",
            "userNum": "102",
            "callType": 1,
            "callDir": 2,
            "ans": 1,
            "ring": 0.0,
            "duration": 498.0,
            "calledUserNum": "00000000-0000-0000-0000-000000000012",
            "calledUserName": "Test User 2",
            "docId": "00000000-0000-0000-0000-000000000011"
        }
    ],
    "summary": [
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ][
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ],
    "status": 1,
    "statusMessage": "Report processing complete",
    "rowLimit": 1000000
}

Errors #

Unauthorised #

When the token is not provided, invalid or expired

HTTP/1.1 401 Unauthorised