Get Results

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/requests/00000000-0000-0000-0000-000000000005/data> HTTP/1.1
Authorisation: 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": "07977502880",
            "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": "07977502880",
            "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