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

פרסם בקשה להריץ דוח לתקופה מסוימת (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" 
}

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

בקשה #

 
פוסט <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", 
    "dateFilter": { 
       "התחל": "2025-09-26T09:00:00+01:00", 
        "סוף": "2025-09-26T17:00:00+01:00" 
    }
}

info
ה-'presetName' יכול להיות כל אחד מהמסננים התקפים Preset Date 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": { 
            "התחל": "2025-09-26T09:00:00+01:00", 
            "סוף": "2025-09-26T17:00:00+01:00", 
            "presetFilterObject": { 
                "יחידות": 5, 
                "הזזה": 0, 
                "אורך": 1, 
                "מצב עיגול": 1, 
                "daysOfWeek": 127
            }, 
            "daysOfWeek": 127
        }, 
        "התחל": "2025-09-26T09:00:00+01:00", 
        "סוף": "2025-09-26T17:00:00+01:00" 
    }, 
    "סטטוס": "הצלחה", 
    "חותמת זמן": "2025-09-22T15:23:02.2982477Z" 
}

טעויות #

לא מורשה #

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

 
HTTP/1.1 401 לא מורשה