1. الصفحة الرئيسية
  2. دليل المستخدم
  3. وثائق RESTful API
  4. حساب واجهة برمجة تطبيقات البيانات [تجريبي]

حساب واجهة برمجة تطبيقات البيانات [تجريبي]

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

{CubeHostAddress} / API / v1 / load

{CubeHostAddress}: https://cube.footfallcam.com (إذا كنت تستخدم حلًا محليًا ، فيرجى استشارة دعم FootfallCam على عنوان المضيف)

خدمة التوصيل سأعين
رؤوس
  1. التفويض: قيمة رمز العائد من API "GenerateAccessToken" من خلال توفير اسم المستخدم وكلمة المرور
النص الأساسي - مثال JSON {
    "استفسار": {
        "الإجراءات": [
            "ThisCubeName.FC01_SUM" ،
            "ThisCubeName.FC01_AVG" ،
            "ThisCubeName.FC02_SUM" ،
            "ThisCubeName.FC02_AVG"
        ],
        "أبعاد الوقت": [
            {
                "البعد": "ThisCubeName.Time" ،
                "نطاق الموعد": [
                    "2021-10-01T10:00:00.000",
                    "2021-10-31"
                ],
                "دقة": "ساعة"
            }
        ],
        "ترتيب": [
            [
                "ThisCubeName.FC01_SUM" ،
                "وصف"
            ]
        ],
        "الفلاتر": [
            {
                "العضو": "ThisCubeName.CompanyId"،
                "عامل التشغيل": "يساوي"،
                "القيم": [
                    "1001"
                ]
            },
            {
                "عضو": "ThisCubeName.BranchId"،
                "عامل التشغيل": "يساوي"،
                "القيم": [
                    "2001" ،
                    "2001"
                ]
            },
            {
                "العضو": "ThisCubeName.BranchName"،
                "عامل التشغيل": "يساوي"،
                "القيم": [
                    "BranchName1" ،
                    "BranchName2"
                ]
            },
            {
                "العضو": "ThisCubeName.AreaId"،
                "عامل التشغيل": "يساوي"،
                "القيم": [
                    "3001" ،
                    "3002" ،
                    "3003"
                ]
            }
        ],
        "أبعاد": [
            "ThisCubeName.CompanyId" ،
            "ThisCubeName.CompanyName" ،
            "ThisCubeName.BranchId" ،
            "ThisCubeName.BranchName" ،
            "ThisCubeName.AreaId" ،
            "ThisCubeName.AreaName"
        ],
        "الحد": 50000
    }
}
وصف الجسم

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

  1. الاستعلام (الكائن): لتحديد الحمولة لبيانات الاستعلام
  2. المقاييس (قائمة السلسلة): لتحديد قائمة الرموز المترية ونوع التجميع.
  3. timeDimensions (قائمة الكائن): تحتوي على كائن لتعريف المعلمات ذات الصلة بالوقت
    1. البعد (سلسلة): لتحديد البعد لتطبيق المعلمات ذات الصلة بالوقت
    2. dateRange (قائمة السلسلة): لتحديد وقت تاريخ البدء والانتهاء لاستعلام البيانات. مثال: "2021-10-01T10: 00: 00.000" ، "2021-10-31"
    3. دقة (سلسلة): لتحديد دقة الوقت للبيانات. مثال: دقيقة ، ساعة ، يوم ، أسبوع ، شهر ، سنة
  4. ترتيب (قائمة سلسلة): لتحديد ترتيب البيانات. تحتوي كل قائمة ثانوية على اسم حقل لتطبيق الطلب ونوع الطلب الخاص به. مثال: ["ThisCubeName.FC01_SUM"، "desc"]
  5. عوامل التصفية (قائمة الكائن): لتحديد تصفية بيانات الاستعلام.
    1. عضو (سلسلة): لتحديد البعد لتطبيق عامل التصفية.
    2. عامل (سلسلة): لتحديد نوع عامل التصفية. مثال: يساوي ، لا يساوي ، يحتوي ، لا يحتوي
    3. القيم (قائمة السلسلة): لتحديد قيمة لتصفية البيانات.
  6. الأبعاد (قائمة السلسلة): لتحديد بُعد لعرضه في بيانات النتائج ، على غرار عبارة "تحديد" في استعلام SQL.
  7. الحد (عدد صحيح ، اختياري): لتحديد الحد الأقصى لعدد سجل البيانات التي تم إرجاعها. ستكون القيمة الافتراضية 10000 (إذا لم يتم تحديدها في الحمولة) ، والحد الأقصى للقيمة هو 50000.
الرد 1 - مثال JSON {
    "خطأ": "متابعة الانتظار" ،
    "المسرح": {
        "المرحلة": "تنفيذ الاستعلام" ،
        "الوقت المنقضي": 5003
    }
}
وصف الرد 1 رد "استمر في الانتظار" يشير ببساطة إلى أن الواجهة الخلفية قد تستغرق بعض الوقت لتنفيذ الاستعلام وإرجاع النتيجة. ليس بسبب فشل استدعاء واجهة برمجة التطبيقات ، يتم تنفيذ الاستعلام في الخلفية. أعد المحاولة بعد ذلك وستقوم واجهة برمجة التطبيقات بإرجاع النتيجة بمجرد تنفيذ النهاية الخلفية للاستعلام.
الرد 2 - مثال JSON {
    "استفسار": {}،
    "بيانات": [
{
            "cube3.CompanyId": "18330"،
            "cube3.CompanyName": "DemoCompany"،
            "cube3.BranchId": "23097"،
            "cube3.BranchName": "UKSite01" ،
            "cube3.AreaId": "-1"،
            "cube3.AreaName": فارغة,
            "cube3.Time.hour": "2022-01-15T11:00:00.000",
            "cube3.Time": "2022-01-15T11:00:00.000",
            "cube3.FC01_SUM": 200 ،
            "cube3.FC01_MAX": 180 ،
            "cube3.FC01_AVG": 100 ،
            "cube3.FC01_MIN": 20 ،
            "cube3.FC02_SUM": 188 ،
            "cube3.FC02_MAX": 171 ،
            "cube3.FC02_AVG": 94 ،
            "cube3.FC02_MIN": 17
        },
        {
            "cube3.CompanyId": "18330"،
            "cube3.CompanyName": "DemoCompany"،
            "cube3.BranchId": "23097"،
            "cube3.BranchName": "UKSite01" ،
            "cube3.AreaId": "-1"،
            "cube3.AreaName": فارغة,
            "cube3.Time.hour": "2022-01-07T15:00:00.000",
            "cube3.Time": "2022-01-07T15:00:00.000",
            "cube3.FC01_SUM": 175 ،
            "cube3.FC01_MAX": 100 ،
            "cube3.FC01_AVG": 87.5 ،
            "cube3.FC01_MIN": 75 ،
            "cube3.FC02_SUM": 174 ،
            "cube3.FC02_MAX": 95 ،
            "cube3.FC02_AVG": 87 ،
            "cube3.FC02_MIN": 79
        },
        {
            "cube3.CompanyId": "18330"،
            "cube3.CompanyName": "DemoCompany"،
            "cube3.BranchId": "23097"،
            "cube3.BranchName": "UKSite01" ،
            "cube3.AreaId": "-1"،
            "cube3.AreaName": فارغة,
            "cube3.Time.hour": "2022-01-15T13:00:00.000",
            "cube3.Time": "2022-01-15T13:00:00.000",
            "cube3.FC01_SUM": 171 ،
            "cube3.FC01_MAX": 151 ،
            "cube3.FC01_AVG": 85.5 ،
            "cube3.FC01_MIN": 20 ،
            "cube3.FC02_SUM": 166 ،
            "cube3.FC02_MAX": 146 ،
            "cube3.FC02_AVG": 83 ،
            "cube3.FC02_MIN": 20
        }
],
    "lastRefreshTime": "2022-01-19T07:35:41.259Z",
    "RefreshKeyValues": [
        [
            {
                "Refresh_key": "13688147"
            }
        ]
    ],
    "usedPreAggregations": {}،
    "convertedQuery": {}،
    "requestId": "dda53bef-4d52-4377-aee8-74d2976cafc6-span-1",
    "حاشية. ملاحظة": {}،
    "مصدر البيانات": "افتراضي"،
    "dbType": "prestodb"،
    "extDbType": "cubestore"،
    "خارجي": خطأ ،
    "slowQuery": خطأ
}
وصف الرد 2 ستكون نتيجة حساب البيانات في قسم "البيانات" كقائمة من الكائنات ، وقد تتم إزالة معلومات إضافية أخرى في المستقبل.
تم التحديث في فبراير 22 و 2023