סקירת הדוחות

סקירת הדוחות #

משאב הדוחות מספק את היכולת לשאול ולהריץ דוחות שהוגדרו במרחב העבודה המיוחס.

/{VERSION}/workspaces/{WORKSPACE_ID}/reports

ממשקים זמינים #

ממשק תיאור
Get All מחזיר אוסף של דוחות מוגדרים.
בקשת פוסט מפרסם בקשה להריץ את הדו"ח.
קבל סטטוס שואלת את מצב הבקשה שסופקה.
קבל תוצאות שואלת את נתוני התוצאה של הבקשה שסופקה.

סכימות #

דיווחים #

מפתח תיאור סוג
id מזהה ייחודי להפניה לדוח זה GUID
שם שם ידידותי למשתמש עבור מופע הדוח מיתר

מצב הדיווח #

נתונים תיאור סוג
תאריך נוצר חותמת הזמן של תאריך יצירת הבקשה דייטטיים
tenantId זיהוי שוכר לקוח של הבקשה GUID
requestId תעודת זהות ייחודית לבקשה. GUID
דיווח מזהה ייחודי למופע הדוח. GUID
סטטוס Enum של בקשת הדוח status מיתר
סטטוסמס הודעה מורחבת לסטטוס מיתר
reportTemplateName שם תבנית ל-reportId. כל סוג תבנית מכיל מידע שונה על קריאות. (למשל רשימות, סיכומים וכו') מיתר
rowLimitExceeded ערך Bool מציין האם פלט הדוח מקוצר בהתאם למגבלת השורה המוגדרת. בול

תוצאות הדוח #

בקשה תיאור סוג
requestId תעודת זהות ייחודית לבקשה. GUID
tenantId זיהוי שוכר לקוח של הבקשה GUID
בקשה אובייקט הבקשה מכיל פרטים על הדוח, כולל מידע על שדות שהוחזרו, מיון וסינונים שהוחלו. אובייקט בקשה
שאילתה-משך הזמן שלוקח לחלץ נתונים עבור הבקשה במילישניות. int
משך כולל הזמן שלוקח לבצע את הבקשה במילישניות. מיתר
שאילתם-ספירת מספר הרשומות שעובדו עבור הדוח int
סך הכל מספר הרשומות שהוחזרו בדוח מיתר
rowLimitExceeded ערך Bool מציין האם פלט הדוח נחתך בהתאם למגבלת השורה שהוגדרה מיתר
נתונים מערך שורות נתונים שמכיל את תוצאת הדוח. השתמש במידע של displayFields באובייקט Request כדי לזהות את פרטי הנתונים שהוחזרו. הערה: אם שדה מסוים שמוזכר ב-'displayFields' אינו קיים בשורת הנתונים, הוא ריק (מחרוזת) או שקרי (bool). מערך
תקציר אם רלוונטי, זה מכיל נתוני שורות סיכום עבור כל שורה במערך הנתונים. מערך

אובייקט בקשה #

בקשה תיאור סוג
requestId תעודת זהות ייחודית לבקשה. GUID
תאריך נוצר חותמת הזמן של תאריך יצירת הבקשה דייטטיים
tenantId זיהוי שוכר לקוח של הבקשה GUID
דיווח מזהה ייחודי למופע הדוח. GUID
reportTemplateName שם תבנית ל-reportId. כל סוג תבנית מכיל מידע שונה על קריאות. (למשל רשימות, סיכומים וכו') מיתר
filterConditions פרטי המסנן שהוחל על הדוח מטרה
sortFields מערך של סדרי מיון המיושם על שדה אחד או יותר. מערך (סדר מיון)
displayFields מערך שדות שמוחזרים עבור כל שורה בדוח מערך (שדה תצוגה)
שדות תצוגה ילד מערך שדות ילד שמוחזרים עבור כל שורה בדוח (אם רלוונטי) מיתר
מטא-דאטה מידע נוסף בנוגע לדוח שהוחזר מטרה

אובייקט סדר מיון #

בקשה תיאור סוג
שם שדה השם האישי של התחום מיתר
בימוי Enum עבור סדר המיון המיושם בשדה זה סדר מיון

אובייקט שדה תצוגה #

בקשה תיאור סוג
שם שדה השם האישי של התחום מיתר
חובה ערך Bool מציין אם השדה הוא חובה לדוח בול

אנומס #

סטטוס #

ערך תיאור
התחלה אתחול השאילתה
ספירה ספירת שורות נתונים רלוונטיות
שאילתה חיפוש נתונים רלוונטיים עבור מסד הנתונים
מעובד עיבוד נתוני הדו"ח.
מיון מיון נתוני הדו"ח.
טוטלינג מילוי שדות כוללים
אחוז כולל מילוי אחוז השדות הכולל
המרה המרת מערך נתוני תחזיר
הושלם הושלם

מסנני תאריך מוגדרים מראש #

ערך תיאור
היום נתונים מהיום ועד 15 דקות לפני ריצת הדוח
אתמול נתונים מהיום הקודם.
השבוע נתונים מהשבוע הנוכחי.
שבוע שעבר נתונים מהשבוע הקודם.
החודש הזה נתונים מהחודש הנוכחי.
החודש האחרון נתונים מהחודש הקודם.
הרבעון הזה נתונים מהרבעון הנוכחי

סדר מיון #

ערך תיאור
עלייה 1
ירידה 2

מסננים נוספים #

מפעילים #

ערך תיאור חל על
= שווים כל סוגי הנתונים
!= לא שווה כל סוגי הנתונים
> גדול מ דאבל, דייטטיים
>= גדול מ-או שווה דאבל, דייטטיים
< פחות מ דאבל, דייטטיים
<= קטן מאו שווה דאבל, דייטטיים
SW מתחיל עם. מיתר
ניו סאות' ויילס זה לא מתחיל ב. מיתר
CT מכיל. מיתר
NCT לא מכיל מיתר
איכס מסתיים ב מיתר
חדש זה לא נגמר ב מיתר

דוגמאות #

דוגמה - כיוון שיחה = נכנס # 

 
{ 
    "reportId": "00000000-00000-0000-0000-0000-00000000001", 
    "dateFilter": { 
        "presetName": "ThisQuarter" 
    }, 
    "תנאים נוספים" : \[{ 
        "fieldName" : "callDir", 
        "operator" : "=", 
        "ערכים" : ["2"][ "2" ] 
    }]

}

דוגמה - חיוג פנימי ישיר = '(123) 456 7890' # 

 
{ 
    "reportId": "00000000-00000-0000-0000-0000-00000000001", 
    "dateFilter": { 
        "presetName": "ThisQuarter" 
    }, 
    "תנאים נוספים" : \[{ 
        "fieldName" : "ddi", 
        "operator" : "=", 
        "ערכים" : ["+11234567890"][ "+11234567890" ] 
    }]

}

דוגמה - חיוג ישיר פנימה מתחיל ב-'123' # 

 
{ 
    "reportId": "00000000-00000-0000-0000-0000-00000000001", 
    "dateFilter": { 
        "presetName": "ThisQuarter" 
    }, 
    "תנאים נוספים" : \[{ 
        "fieldName" : "ddi", 
        "operator" : "=", 
        "ערכים" : ["+1123"][ "+1123" ] 
    }]

}

דוגמה - מספרי משתמש 1002 ו-1002 # 

 
{ 
    "reportId": "00000000-00000-0000-0000-0000-00000000001", 
    "dateFilter": { 
        "presetName": "ThisQuarter" 
    }, 
    "תנאים נוספים" : \[{ 
        "fieldName" : "userNum", 
        "operator" : "=", 
        "ערכים" : ["1001", "1002"][ "1001", "1002" ] 
    }]

}