نظرة عامة على التقارير on ~.Dimensions.~

احصل على جميع التقارير

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

احصل على جميع التقارير #

يحصل على قائمة بجميع التقارير المهيأة في مساحة عمل محددة. بمجرد استرجاع قائمة بجميع التقارير، يمكن تنفيذها واسترجاع البيانات باستخدام معرف تقرير محدد.

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": [{ 
            "معرف": "00000000-0000-0000-0000-0000-00000000001", 
            "الاسم": "قائمة المكالمات (مقسمة)" 
        }, { 
            "id": "00000000-0000-0000-0000-00000-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-0000-0000-0000-00000-00000000001", 
    "filterId": "00000000-0000-0000-0000-0000-00000000001", 
    "dateFilter": { 
        "presetName": "هذا الربع" 
    }, 
    "الشروط الإضافية" : \[]

}

info
يمكن أن يكون 'presetName' أي من <مرشحات تاريخ الإعداد المسبق</c1> الصحيحة c1>presetDate).

info
يمكن استخدام 'filterId' لتطبيق مرشح محدد مسبقا على التقرير. إذا لم يتم توفيره، سيتم استخدام المرشح الافتراضي المطبق على التقرير المطلوب.

info
يمكن استخدام 'additionalConditions' لتطبيق Additional Filters على التقرير. ستكمل هذه المرشحات أي معلمات محددة في مرشح محدد مسبقا.

الرد #

 
HTTP/1.1 200 OK
نوع المحتوى: application/json; charset=utf-8
مدة المحتوى: xx
{ 
    "data": { 
        "requestId": "00000000-0000-0000-0000-0000-00000000005", 
        "locale": "en-GB", 
        "reportId": "00000000-0000-0000-0000-00000-00000000001", 
        "مرجع تاريخ": "2025-09-22T15:23:01.0201791+00:00", 
        "dateFilter": { 
            "presetName": "ThisQuarter", 
            "presetFilterObject": { 
                "وحدات": 5, 
                "الإزاحة": 0, 
                "الطول": 1, 
                "وضع التقريب": 1, 
                "أيام الأسبوع": 127
            }, 
            "أيام الأسبوع": 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": { 
        "تاريخ الإنشاء": "2025-09-22T15:27:40.1946146Z", 
        "tenantId": "f8322e65-ddac-4f5c-1f6c-08db2fa7b464", 
        "requestId": "65224fa5-f4c6-4796-b3c8-c4f67d504971", 
        "reportId": "2aafb829-91aa-4d17-a5d3-bb6fde34ca10", 
        "الحالة": "مكتمل"، 
        "stateMessage": "اكتملت معالجة التقرير"، 
        "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-0000-0000-0000-0000-00000000005", 
    "tenantId": "00000000-00000-0000-0000-00000-000000000000"، 
    "طلب": { 
        "requestId": "00000000-0000-0000-0000-0000-00000000005", 
        "تاريخ الإنشاء": "2025-09-22T15:27:40.1946146Z", 
        "tenantId": "00000000-00000-0000-0000-00000-000000000000"، 
        "reportId": "00000000-0000-0000-0000-00000-00000000001", 
        "reportTemplateName": "CallListByUserSegmented", 
        "filterConditions": \[ 
            { 
                "fieldName": "ابدأ", 
                "operator": ">=", 
                "القيم": ["2025-01-01T00:00:00.0000000+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", 
                "إلزامي": غير صحيح
            }, 
            { 
                "اسم الحقل": "cli", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "cliName", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "hgNum", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "callType", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "callDir", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "ans", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "ref", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "مفقود", 
                "إلزامي": غير صحيح
            }, 
            { 
                "fieldName": "ring", 
                "إلزامي": غير صحيح
            }, 
            { 
                "اسم الحقل": "المدة", 
                "إلزامي": غير صحيح
            }, 
            { 
                "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": \[], 
        "تجاهل DisplayFields": خطأ، 
        "البيانات الوصفية": { 
            "reportName": null, 
            "dateFilter": { 
                "presetName": "هذا العام", 
                "presetFilterObject": { 
                    "وحدات": 6, 
                    "الإزاحة": 0, 
                    "الطول": 1, 
                    "وضع التقريب": 1, 
                    "أيام الأسبوع": 127
                }, 
                "أيام الأسبوع": 127
            }, 
            "تاريخ المرجع": "2025-09-22T15:27:40.1423161+00:00", 
            "timeZoneReferenceDate": "2025-09-22T16:27:40", 
            "filterId": null, 
            "إضافي الفلاتر": \[], 
            "workspaceFilterId": null, 
            "timezoneDateFrom": "2025-01-01T00:00:00", 
            "timezoneDateTo": "2025-09-22T16:12:40", 
            "timeZoneDateCreated": "2025-09-22T15:27:40.1423517+00:00", 
            "اختصار منطقة الزمن": "BST" 
        }, 
        "المصدر": "api.onboarding", 
        "حجم الصفحة": -1، 
        "حجم الدفعة": -1، 
        "حد الصف": 1000000، 
        "مستوى الأولوية": 2، 
        "callRatePeriod": 120, 
        "تجاهل المكالمات المهجورة": خاطئ، 
        "تجاهل المكالمات القصيرة المجاوبة": خاطئ، 
        "accountCodeLabels": {}, 
        "عتبات الخاتم": [ 
            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، 
        "المكالمات الواردة في البيع": 5، 
        "الإيرادات المقدرة الصادرة": 100.0, 
        "مكالمات في الخصم الصادرة": 5, 
        "مدة مجموعة الفترة في الثانية": 10, 
        "timeZoneId": "أوروبا/لندن", 
        "رمز البلاد": "GB", 
        "locale": "en-GB", 
        "totalTrunks": 10, 
        "maxRows": 0
    }, 
    "الجهد": 210.17, 
    "استعلام المدة": 2076، 
    "إجمالي المدة": 2121, 
    "queryCount": 2053، 
    "rowLimitExceeded": خاطئ، 
    "totalCount": 922, 
    "البيانات": [ 
        { 
            "connId": "00000000-00000-0000-0000-000000000001", 
            "ابدأ": "2025-09-18T11:16:31", 
            "userName": "اختبر المستخدم 1", 
            "userNum": "101", 
            "CLI": "+11234567890", 
            "cliName": "", 
            "hgNum": "200", 
            "نوع النداء ": 2, 
            "callDir": 2, 
            "الخاتم": 1.0، 
            "المدة": 1.0, 
            "calledUserNum": "+19876543210", 
            "calledUserName": "غير معروف", 
            "callUserNum": "+11234567890", 
            "hgName": "طابور 200", 
            "docId": "00000000-0000-0000-0000-00000-00000000009" 
        }, 
        { 
            "connId": "000000000-00000-0000-00000-00000000002", 
            "البدء": "2025-09-18T11:16:13", 
            "userName": "اختبر المستخدم 1", 
            "userNum": "101", 
            "CLI": "+11234567890", 
            "cliName": "", 
            "نوع النداء ": 2, 
            "callDir": 3, 
            "جواب": 1, 
            "خاتم": 5.0, 
            "المدة": 6.0, 
            "calledUserNum": "+19876543210", 
            "callUserName": المستخدم الاختبار 1", 
            "callUserNum": "101", 
            "docId": "000000000-0000-0000-0000-000000000010" 
        }, 
        { 
            "connId": "00000000-0000-0000-0000-000000000003", 
            "ابدأ": "2025-01-03T16:44:40", 
            "userName": "Test User 2", 
            "userNum": "102", 
            "نوع النداء ": 1, 
            "callDir": 2, 
            "جواب": 1, 
            "الخاتم": 0.0, 
            "المدة": 498.0, 
            "calledUserNum": "00000000-0000-0000-0000-00000-00000000012", 
            "calledUserName": "اختبر المستخدم 2", 
            "docId": "00000000-00000-0000-0000-00000-00000000011" 
        }
    ][
        {
            "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، 
            "المرجع": 37, 
            "ضائع": 79، 
            "رينغ": 3318.0, 
            "المدة": 124315.0
        }
    ][
        {
            "ans": 621,
            "ref": 37,
            "lost": 79,
            "ring": 3318.0,
            "duration": 124315.0
        }
    ]، 
    "الحالة": 1, 
    "stateMessage": "اكتملت معالجة التقرير"، 
    "حد الصف": 1000000
}

الأخطاء #

غير مصرح به #

عندما لا يتم توفير الرمز أو غير صالح أو منتهية الصلاحية

 
HTTP/1.1 401 غير مصرح به