Berichtsübersicht #

Die Reports-Ressource bietet die Möglichkeit, Berichte abzufragen und auszuführen, die im referenzierten Arbeitsbereich konfiguriert sind.

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

Verfügbare Schnittstellen #

Schnittstelle	Beschreibung
Macht alles	Gibt eine Sammlung konfigurierter Berichte zurück.
Anfrage nach der Post	Postet eine Anfrage, den Bericht zu veröffentlichen.
Status erhalten	Fragt nach dem Status der bereitgestellten Anfrage.
Ergebnisse erhalten	Abfrage der Ergebnisdaten der bereitgestellten Anfrage.

Schemata #

Berichte #

Legende	Beschreibung	Typ
id	Eindeutige Kennung zur Referenz auf diesen Bericht	GUID
Name	Benutzerfreundlicher Name für die Berichtsinstanz	String

Berichtsstatus #

Daten	Beschreibung	Typ
DatumErstellt	Zeitstempel des Erstellungsdatums der Anfrage	DateTime
MieterID	Kunden-Tenant-ID der Anfrage	GUID
requestId	Eindeutige ID für die Anfrage.	GUID
Bericht	Eindeutige ID für die Berichtsinstanz.	GUID
Status	Enum der Berichtsanfrage status	String
statusNachricht	Erweiterte Nachricht zum Status	String
reportTemplateName	Vorlagenname für die ReportId. Jeder Vorlagentyp enthält unterschiedliche Rufinformationen. (z. B. Listen, Zusammenfassungen usw.)	String
rowLimitExceeded	Bool-Wert gibt an, ob die Berichtsausgabe basierend auf dem konfigurierten Zeilenlimit abgeschnitten wird.	Bool

Berichtsergebnisse #

Anfrage	Beschreibung	Typ
requestId	Eindeutige ID für die Anfrage.	GUID
MieterID	Kunden-Tenant-ID der Anfrage	GUID
Anfrage	Das Request-Objekt enthält Details zum Bericht, einschließlich Informationen zu zurückgegebenen Feldern, Sortierung und angewandten Filtern.	Anfrageobjekt
queryDuration	Zeit, die benötigt wird, um die Daten für die Anfrage zu extrahieren, in Millisekunden.	Int
gesamtDauer	Zeit, die zur Ausführung der Anfrage in Millisekunden benötigt wird.	String
queryCount	Anzahl der für den Bericht verarbeiteten Datensätze	Int
totalCount	Anzahl der im Bericht zurückgegebenen Unterlagen	String
rowLimitExceeded	Sool-Wert gibt an, ob die Berichtsausgabe basierend auf dem konfigurierten Zeilenlimit abgeschnitten wird	String
Daten	Ein Array von Datenzeilen, das das Ergebnis des Berichts enthält. Verwenden Sie die displayFields-Informationen im Request-Objekt, um die Details der zurückgegebenen Daten zu identifizieren. Hinweis: Wenn ein bestimmtes Feld, das in 'displayFields' referenziert wird, nicht in der Datenzeile existiert, ist es leer (Zeichenkette) oder falsch (bool).	Array
Zusammenfassung	Falls zutreffend, enthält dies Zusammenfassungszeilendaten für jede Zeile im Datenarray.	Array

Anfrageobjekt #

Anfrage	Beschreibung	Typ
requestId	Eindeutige ID für die Anfrage.	GUID
DatumErstellt	Zeitstempel des Erstellungsdatums der Anfrage	DateTime
MieterID	Kunden-Tenant-ID der Anfrage	GUID
Bericht	Eindeutige ID für die Berichtsinstanz.	GUID
reportTemplateName	Vorlagenname für die ReportId. Jeder Vorlagentyp enthält unterschiedliche Rufinformationen. (z. B. Listen, Zusammenfassungen usw.)	String
filterBedingungen	Details des auf den Bericht angewandten Filters	Ziel
sortFields	Array of Sort-Orders wurde auf ein oder mehrere Felder angewendet.	Array (Sortierreihenfolge)
displayFields	Array von Feldern, die für jede Zeile im Bericht zurückgegeben werden	Array (Display Field)
childDisplayFields	Array von Kindfeldern, die für jede Zeile im Bericht zurückgegeben werden (falls zutreffend)	String
MetaData	Weitere Informationen zum zurückgegebenen Bericht	Ziel

Sortierreihenfolge-Objekt #

Anfrage	Beschreibung	Typ
fieldName	Id-Name für das Feld	String
Regie	Enum für die auf dieses Feld angewandte Sortierreihenfolge	Sortierreihenfolge

Display-Feldobjekt #

Anfrage	Beschreibung	Typ
fieldName	Id-Name für das Feld	String
Pflicht	Bool-Wert gibt an, ob das Feld für den Bericht verpflichtend ist	Bool

Enums #

Status #

Wert	Beschreibung
Start	Initialisierung der Abfrage
Zählen	Zählen der relevanten Datenzeilen
Abfragen	Abfrage der relevanten Daten für die Datenbank
Verarbeitet	Verarbeitung der Berichtsdaten.
Sortierung	Sortiere die Berichtsdaten.
Totalisierung	Bevolkung der Gesamtfelder
TotalingPercent	Befüllung % der Gesamtfelder
Umwandlung	Konvertierung des Rückgabedatensatzes
Vollständig	Abgeschlossen

Voreingestellte Datumsfilter #

Wert	Beschreibung
Heute	Daten von heute bis 15 Minuten vor dem Bericht
Gestern	Daten vom Vortag.
DieseWoche	Daten aus der aktuellen Woche.
Letzte Woche	Daten aus der Vorwoche.
DieserMonat.	Daten aus dem aktuellen Monat.
Letzter Monat	Daten aus dem letzten Monat.
Dieses Quartal	Daten aus dem aktuellen Quartal

Sortierreihenfolge #

Wert	Beschreibung
Aufstieg	1
Absteigend	2

Zusätzliche Filter #

Betreiber #

Wert	Beschreibung	Gilt für
=	Gleich	Alle Datentypen
!=	Das ist nicht gleich	Alle Datentypen
>	Größer als	Doppel, Datetime
>=	Größer als oder gleich	Doppel, Datetime
<	Weniger als	Doppel, Datetime
<=	Kleiner als oder gleich	Doppel, Datetime
SW	Fängt an mit.	Saite
NSW	Fängt nicht an mit.	Saite
CT	Enthält.	Saite
NCT	Enthält nicht	Saite
Igitt.	Endet mit	Saite
neu	Endet nicht mit	Saite

Beispiele #

Beispiel – Anrufrichtung = Eingehend #

{
    "reportId": "00000000-0000-0000-00000-000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "zusätzlicheBedingungen" : \[{
        "fieldName": "callDir",
        "Operator" : "=",
        "Werte": ["2"][ "2" ]
    }]

}

Beispiel – Direct Inward Dial = '(123) 456 7890' #

{
    "reportId": "00000000-0000-0000-00000-000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "zusätzlicheBedingungen" : \[{
        "fieldName": "ddi",
        "Operator" : "=",
        "Werte": ["+11234567890"][ "+11234567890" ]
    }]

}

Beispiel – Direkt-Inward Dial beginnt mit '123' #

{
    "reportId": "00000000-0000-0000-00000-000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "zusätzlicheBedingungen" : \[{
        "fieldName": "ddi",
        "Operator" : "=",
        "Werte": ["+1123"][ "+1123" ]
    }]

}

Beispiel – Benutzernummern 1002 und 1002 #

{
    "reportId": "00000000-0000-0000-00000-000000001",
    "dateFilter": {
        "presetName": "ThisQuarter"
    },
    "zusätzlicheBedingungen" : \[{
        "fieldName" : "userNum",
        "Operator" : "=",
        "Werte": ["1001", "1002"][ "1001", "1002" ]
    }]

}