סקירת הדוחות on ~.Dimensions.~

קבלו את כל הדיווחים

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

קבלו את כל הדיווחים #

מקבל רשימה של כל הדוחות שהוגדרו במרחב עבודה מסוים. לאחר שהרשימה של כל הדוחות נמשכה, ניתן להריץ אותה ולשלוף נתונים באמצעות reportId מסוים.

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

דוגמה #

בקשה זו תקבל רשימה של כל הדוחות שהוגדרו בתוך מרחב העבודה שצוין.

בקשה #

 
קבל <https://api.na.myreports.cloud/api/v1.0/workspaces/00000000-0000-0000-0000-000000000001/reports> HTTP/1.1
הרשאה: נושא {TOKEN}

תגובה #

 
HTTP/1.1 200 OK
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
{ 
	"page_size": 3, 
    "page_index": 0, 
    "data": [{ 
            "id": "00000000-0000-0000-0000-00000-00000000001", 
            "שם": "רשימת שיחות (מחולקת)" 
        }, { 
            "id": "00000000-00000-0000-0000-0000-00000000002", 
            "שם": "שיחות לפי שם תור" 
        }, { 
            "ID": "00000000-0000-0000-0000-00000-00000000003", 
            "שם": "שיחות על ידי משתמש" 
        }
    ][{
            "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"
        }
    ], 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-05-01T10:00:00.2890319Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

בקשת דיווח לאחר מכן

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

בקשת דיווח לאחר מכן #

פרסם בקשה להריץ דוח לתקופה מסוימת (dateFilter).

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

דוגמה לשימוש במסנן תאריך מוגדר מראש #

בקשה זו תריץ דוח לרבעון הנוכחי. גוף ההחזרה מכיל את ה-'requestId' שניתן להשתמש בו לשאילתת מצב הדוח ולשליפת מערך הנתונים.

בקשה #

 
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
סוג תוכן: application/json
הרשאה: נושא {TOKEN}
קשר: לשמור בחיים
{ 
    "reportId": "00000000-00000-0000-0000-0000-00000000001", 
    "filterId": "00000000-00000-0000-0000-0000-000000000001", 
    "dateFilter": { 
        "presetName": "ThisQuarter" 
    }, 
    "תנאים נוספים" : \[]

}

info
ה-'presetName' יכול להיות כל אחד מהמסננים התקפים Preset Date Filters.

info
ה-'filterId' יכול לשמש להחלת מסנן מוגדר מראש על הדוח. אם לא מסופק, המסנן ברירת המחדל המופעל על הדוח המבוקש ישמש.

info
ה-'additionalConditions' יכול לשמש ליישום Additional Filters על הדוח. מסננים אלו ישלימו את הפרמטרים המוגדרים במסנן מוגדר מראש.

תגובה #

 
HTTP/1.1 200 OK
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
{ 
    "data": { 
        "requestId": "00000000-00000-0000-0000-00000-00000000005", 
        "locale": "en-GB", 
        "reportId": "00000000-00000-0000-0000-0000-00000000001", 
        "תאריך": "2025-09-22T15:23:01.0201791+00:00", 
        "dateFilter": { 
            "presetName": "ThisQuarter", 
            "presetFilterObject": { 
                "יחידות": 5, 
                "הזזה": 0, 
                "אורך": 1, 
                "מצב עיגול": 1, 
                "daysOfWeek": 127
            }, 
            "daysOfWeek": 127
        }, 
        "זמן התחלה": "2025-07-01T00:00:00+01:00", 
        "סוף זמן": "2025-09-22T16:08:01.02159+01:00" 
    }, 
    "סטטוס": "הצלחה", 
    "חותמת זמן": "2025-09-22T15:23:02.2982477Z" 
}

דוגמה באמצעות טווח תאריכים קבוע #

קבל סטטוס

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

קבל סטטוס #

בקשה זו מקבלת דוח 'requestId' ומחזירה את הסטטוס של הבקשה.

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

דוגמה - בקשה בתהליך #

בקשה זו מחזירה את הסטטוס של בקשת דוח שעדיין פועלת.

בקשה #

 
קבל <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
הרשאה: נושא {TOKEN}

תגובה #

 
HTTP/1.1 200 OK
סוג תוכן: application/json; charset=utf-8
אורך תוכן: 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", 
        "סטטוס": "הושלם", 
        "StatusMessage": "הדיווח על עיבוד הושלם", 
        "reportTemplateName": "CallListByUserSegmented" 
    }, 
	"סטטוס": "הצלחה", 
	"חותמת זמן": "2019-05-01T10:00:00.2890319Z" 
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה

קבל תוצאות

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

קבל תוצאות #

בקשה זו מקבלת דוח 'requestId' ומחזירה את תוצאות הדוח אם הושלם.

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

דוגמה #

בקשה זו מחזירה את נתוני התוצאה של בקשת דוח שהושלמה.

בקשה #

 
קבל <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
הרשאה: נושא {TOKEN}

תגובה #

 
HTTP/1.1 200 OK
סוג תוכן: application/json; charset=utf-8
אורך תוכן: xx
{ 
    "requestId": "00000000-00000-0000-0000-00000-00000000005", 
    "tenantId": "00000000-0000-0000-0000-00000-0000000000", 
    "בקשה": { 
        "requestId": "00000000-00000-0000-0000-00000-00000000005", 
        "dateCreated": "2025-09-22T15:27:40.1946146Z", 
        "tenantId": "00000000-0000-0000-0000-00000-0000000000", 
        "reportId": "00000000-00000-0000-0000-0000-00000000001", 
        "reportTemplateName": "CallListByUserSegmented", 
        "filterConditions": \[ 
            { 
                "fieldName": "התחל", 
                "מפעיל": ">=", 
                "ערכים": ["2025-01-01T00:00:00.00000000+00:00"][
                    "2025-01-01T00:00:00.0000000+00:00"
                ] 
            }, 
            { 
                "fieldName": "סוף", 
                "מפעיל": "\<", 
                "ערכים": ["2025-09-22T15:12:40.1423517+00:00"][
                    "2025-09-22T15:12:40.1423517+00:00"
                ] 
            }
        ], 
        "sortFields": [ 
            { 
                "fieldName": "התחל", 
                "כיוון": 1
            }
        ][
            {
                "fieldName": "start",
                "direction": 1
            }
        ], 
        "displayFields": [ 
            { 
                "fieldName": "connId", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "התחל", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "userName", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "userNum", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "cli", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "cliName", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "hgNum", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "callType", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "callDir", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "ans", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "ref", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "אבוד", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "טבעת", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "משך", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "calledUserNum", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "calledUserName", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "callUserName", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "callUserNum", 
                "חובה": לא נכון
            }, 
            { 
                "fieldName": "hgName", 
                "חובה": לא נכון
            }
        ][
            {
                "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": שקר, 
        "מטא-דאטה": { 
            "reportName": null, 
            "dateFilter": { 
                "presetName": "השנה", 
                "presetFilterObject": { 
                    "יחידות": 6, 
                    "הזזה": 0, 
                    "אורך": 1, 
                    "מצב עיגול": 1, 
                    "daysOfWeek": 127
                }, 
                "daysOfWeek": 127
            }, 
            "תאריך": "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" 
        }, 
        "מקור": "api.onboarding", 
        "pageSize": -1, 
        "גודל אצווה": -1, 
        "RowLimit": 1000000, 
        "רמת עדיפות": 2, 
        "callRatePeriod": 120, 
        "התעלמו משיחות נטושות": שקרי, 
        "התעלמו מ-ShortAnsweredCalls": שקר, 
        "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
        ], 
        "הכנסות מוערכות נכנסות": 100.0, 
        "IncomingCallsPerSale": 5, 
        "הכנסות מוערכות יוצאות": 100.0, 
        "ה-OutgoingCallsPerSale": 5, 
        "durationGroupPeriodInSeconds": 10, 
        "timeZoneId": "אירופה/לונדון", 
        "countryCode": "GB", 
        "locale": "en-GB", 
        "טוט"ל טרנקס": 10, 
        "maxRows": 0
    }, 
    "מאמץ": 210.17, 
    "שאילתה-משך": 2076, 
    "משך כולל": 2121, 
    "QueryCount": 2053, 
    "rowLimitExceded": שקר, 
    "ספירה": 922, 
    "נתונים": [ 
        { 
            "connId": "00000000-0000-0000-0000-00000-0000000001", 
            "התחל": "2025-09-18T11:16:31", 
            "userName": "משתמש בדיקה 1", 
            "userNum": "101", 
            "CLI": "+11234567890", 
            "cliName": "", 
            "hgNum": "200", 
            "callType": 2, 
            "callDir": 2, 
            "טבעת": 1.0, 
            "משך": 1.0, 
            "calledUserNum": "+19876543210", 
            "calledUserName": "לא ידוע", 
            "callUserNum": "+11234567890", 
            "hgName": "תור 200", 
            "docId": "00000000-0000-0000-0000-00000-00000000009" 
        }, 
        { 
            "connId": "00000000-00000-0000-0000-00000000002", 
            "התחל": "2025-09-18T11:16:13", 
            "userName": "משתמש בדיקה 1", 
            "userNum": "101", 
            "CLI": "+11234567890", 
            "cliName": "", 
            "callType": 2, 
            "callDir": 3, 
            "תשובה": 1, 
            "טבעת": 5.0, 
            "משך": 6.0, 
            "calledUserNum": "+19876543210", 
            "callUserName": משתמש בדיקה 1", 
            "callUserNum": "101", 
            "docId": "00000000-00000-0000-0000-00000-000000000010" 
        }, 
        { 
            "connId": "00000000-00000-00000-0000-000000000003", 
            "התחל": "2025-01-03T16:44:40", 
            "userName": "בדיקת משתמש 2", 
            "userNum": "102", 
            "callType": 1, 
            "callDir": 2, 
            "תשובה": 1, 
            "טבעת": 0.0, 
            "משך": 498.0, 
            "calledUserNum": "00000000-0000-0000-0000-0000-00000000012", 
            "calledUserName": "בדיקת משתמש 2", 
            "docId": "00000000-00000-0000-0000-00000-0000000011" 
        }
    ][
        {
            "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"
        }
    ], 
    "סיכום": [ 
        { 
            "תשובה": 621, 
            "ref": 37, 
            "אבוד": 79, 
            "טבעת": 3318.0, 
            "משך": 124315.0
        }
    ][
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ], 
    "סטטוס": 1, 
    "StatusMessage": "הדיווח על עיבוד הושלם", 
    "RowLimit": 1000000
}

טעויות #

לא מורשה #

כאשר האסימון אינו מסופק, אינו תקף או פג תוקף

 
HTTP/1.1 401 לא מורשה