---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Aggregat-API

# Aggregat-API {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 4 Minuten Lesedauer

Die Aggregieren Die API stellt Endpunkte bereit, mit denen Sie aggregierte Statistiken zu vorhandenen Tabellen- und Spaltendaten berechnen können.

Für Aggregieren API-Anforderungen. Sie müssen Lesezugriff für alle Datensätze in der abfragenden Tabelle haben. Wenn eine ACL verhindert, dass der anfordernde Anwender auf einen Datensatz in der Tabelle zugreift, gibt die Anforderung einen Fehler von 403 „unzulässig" zurück.

## Aggregieren -- RUFT /now/stats/{tableName} AB {#ariaid-title2}

Ruft Datensätze für die angegebene Tabelle ab und führt Aggregatfunktionen für die zurückgegebenen Werte aus.
Sie können angeben, welche Aggregatfunktionen ausgeführt werden sollen, indem Sie entweder verwenden sysparm_\<aggregate\>_fieldsParameter oder sysparm_having=\<aggregate\>\^field\^operator\^valueParameter, ersetzt \<aggregate\>Für eine dieser Aggregatfunktionen:  
* durchschn
* max.
* min
* sum
{#aggregate-GET-stats__ul_yyv_vcn_yq}

### URL-Format {#aggregate-GET-stats__section_qsm_m1r_cmb}

Versionierte URL: /api/now/{api_Version}/stats/{tableName}

Standard-URL: /api/now/stats/{tableName}  
Hinweis:  
Verfügbare Versionen werden in angegeben [REST-API-Explorer](https://servicenow-prod.fluidtopics.net/QZyr9s_~V0xB9fqGOlvJ4A "In diesem Tutorial verwenden Sie den REST API Explorer, um zu testen ServiceNowREST-APIs."). Für geskriptete REST-APIs gibt es zusätzliche Versionsinformationen auf [Geskriptetes REST-Service-Formular](https://servicenow-prod.fluidtopics.net/0V9QfkPsOI5r~YAD7CJWCA "Mit der geskripteten REST-API-Funktion können Anwendungsentwickler anwenderdefinierte Webservice-APIs erstellen.").

### Unterstützte Anforderungsparameter

{#aggregate-GET-stats__entry__2}{#aggregate-GET-stats__version-not_optional-RESTAPI}

| Name | Beschreibung |
|-|-|
| api_version | Optional. Version des Endpunkts, auf den zugegriffen werden soll. Beispiel: <kbd class="ph userinput">v1 </kbd>Oder <kbd class="ph userinput">v2 </kbd>. Geben Sie diesen Wert nur an, um eine andere Endpunktversion als die neueste zu verwenden. Datentyp: Zeichenfolge |
| tableName | Name der Tabelle, für die Datensätze abgerufen werden sollen. Datentyp: Zeichenfolge |
[Tabelle : 1. Pfad-Parameter]

{#aggregate-GET-stats__entry__8}

| Name | Beschreibung |
|-|-|
| Name-Wert-Paare | Eine Alternative zur Verwendung von sysparm_queryParameter. Sie können eine Abfrage mithilfe von Schlüssel-Wert-Paaren filtern, wobei der Schlüssel der Name eines Felds ist. Beispiel: Anstatt den Parameter zu verwenden `&Sysparm_query=Active=true `, Können Sie verwenden `&Active=wahr `. Sie können den Anzeigewert verwenden, wenn das Feld ein Auswahl- oder Referenztypfeld ist, z. B. `&Status=Geschlossen `Anstelle von `&Status=7 `. Um mehrere Schlüssel-Wert-Paare anzugeben, trennen Sie jedes durch ein und-Zeichen, z. B. `&Active=wahr&assigned_to=john.smith `. Datentyp: Zeichenfolge |
| Sysparm_\<aggregate\>_fields | Liste der Felder, für die die einzelnen Aggregatvorgänge ausgeführt werden sollen. Sie können mehrere Felder angeben, indem Sie jedes durch ein Komma trennen. Verwenden Sie beispielsweise, um die Durchschnittswerte aus den Feldern „Dauer" und „Priorität" abzurufen `Sysparm_avg_fields=duration,Priority `. Hinweis: Geben Sie diesen Parameter an, d. h. sysparm_countParameter oder beides für Ihre Abfrage, um aussagekräftige Ergebnisse zurückzugeben. Wenn keiner der Parameter übergeben wird, wird kein Aggregatvorgang ausgeführt. Datentyp: Zeichenfolge |
| Sysparm_count | Kennzeichnung, die bestimmt, ob die Anzahl der von der Abfrage zurückgegebenen Datensätze zurückgegeben werden soll. Hinweis: Geben Sie diesen Parameter an, d. h. sysparm_\<aggregate\>_fieldsParameter oder beides für Ihre Abfrage, um aussagekräftige Ergebnisse zurückzugeben. Wenn keiner der Parameter übergeben wird, wird kein Aggregatvorgang ausgeführt. Datentyp: Zeichenfolge |
| Sysparm_Display_value | Datenabrufvorgang beim Gruppieren nach Referenz- oder Auswahlfeldern. Basierend auf diesem Wert gibt die Abfrage entweder den Anzeigewert, den ist-Wert in der Datenbank oder beides zurück. * Wahr: Gibt Anzeigewerte für alle Felder zurück. * Falsch: Gibt ist-Werte aus der Datenbank zurück. Wenn kein Wert angegeben ist, wird dieser Parameter standardmäßig auf „falsch" gesetzt. * Alle: Gibt sowohl ist-Werte als auch Anzeigewerte zurück. {#aggregate-GET-stats__ul_eyx_ccn_yq}Es gibt keine bevorzugte Methode zum Festlegen dieses Parameters. Die Angabe des Anzeigewerts kann jedoch zu Leistungsproblemen führen, da sie nicht aus der Datenbank gelesen werden und auf andere Felder und Datensätze verweisen können. Weitere Informationen zu Anzeigewerten und ist-Werten finden Sie unter [Tabellen-API -- häufig gestellte Fragen (KB0534905)](https://support.servicenow.com/kb_view.do?sysparm_article=KB0534905). Datentyp: Zeichenfolge |
| Sysparm_Group_by | Felder, nach denen die zurückgegebenen Daten gruppiert werden sollen. Sie können mehrere Felder angeben, indem Sie jedes Feld durch ein Komma trennen, z. B. `Sysparm_Group_by=Priority,State `. Datentyp: Zeichenfolge |
| Sysparm_having | Zusätzliche Abfrage, mit der Sie die Daten basierend auf einem Aggregatvorgang filtern können. Der Wert für diesen Parameter muss der Syntax entsprechen `Aggregatwert^field^Operator^ `, Z. B. `Anzahl^Priorität^>^3 `Um die Anzahl der Datensätze in den Abfrageergebnissen mit einer Priorität größer als 3 abzurufen. Sie können mehrere Abfragen angeben, indem Sie jede durch ein Komma trennen, z. B. `Ascount^Status^=^1,durchschn^Priorität^>^3 `. Datentyp: Zeichenfolge |
| Sysparm_order_by | Liste der Werte, nach denen gruppierte Ergebnisse angeordnet werden sollen. Sie können eine Reihenfolge mithilfe eines Felds oder einer Zusammenfassung angeben. Beispiel: Wenn Sie angeben `Sysparm_order_by=AVG^State `, Gruppen von Ergebnissen mit niedrigeren durchschnittlichen Statuswerten werden zuerst zurückgegeben. Sie können auch nach ANZAHL sortieren, um Gruppen von Datensätzen nach der Anzahl der Datensätze in jeder Gruppe anzuordnen. Wenn Sie eine Reihenfolge angeben, werden Gruppen standardmäßig in aufsteigender Reihenfolge sortiert. Verwenden `^DESC `Zum Sortieren in absteigender Reihenfolge, z. B. `Sysparm_order_by=State^DESC `. Datentyp: Zeichenfolge |
| Sysparm_query | Eine codierte Abfrage. Beispiel: `(Sysparm_query=Active=true)(sysparm_query=caller_ID=javascript:gs.getUserID()^Active=true) ` Datentyp: Zeichenfolge |
[Tabelle : 2. Abfrageparameter]

{#aggregate-GET-stats__entry__26}

| Name | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 3. Anforderungstext-Parameter (XML oder JSON)]

### Header

Die folgenden Anforderungs- und Antwort-Header gelten nur für diese HTTP-Aktion oder werden auf diese Aktion in einer bestimmten Weise angewendet. Eine Liste der allgemeinen Header, die in der REST-API verwendet werden, finden Sie unter [Unterstützte REST-API-Header](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#aggregate-GET-stats__entry__30}{#aggregate-GET-stats__accept-RESTAPI}

| Header | Beschreibung |
|-|-|
| Akzeptieren | Datenformat des Antworttexts. Unterstützte Typen: application/jsonOder application/xml. Standard: application/json |
[Tabelle : 4. Anforderungskopfzeilen.]

{#aggregate-GET-stats__entry__34}

| Header | Beschreibung |
|-|-|
| Keine |   |
[Tabelle : 5. Antwort-Header]

### Statuscodes

Die folgenden Statuscodes gelten für diese HTTP-Aktion. Eine Liste der möglichen Statuscodes, die in der REST-API verwendet werden, finden Sie unter [REST-API-HTTP-Antwortcodes](https://servicenow-prod.fluidtopics.net/ai2El07oZMsuDDSV75uftQ "REST (repräsentative Statusübertragung) ist eine einfache statuslose Architektur, die Standards zwischen Computersystemen im Web bereitstellt, wodurch sie leichter miteinander kommunizieren können.").
{#aggregate-GET-stats__entry__38}{#aggregate-GET-stats__entry-200-status-code}{#aggregate-GET-stats__entry-401-status-code}{#aggregate-GET-stats__entry-500-status-code}

| Statuscode | Beschreibung |
|-|-|
| 200 | Erfolgreich. Die Anforderung wurde erfolgreich verarbeitet. |
| 401 | Nicht autorisiert Die Anwenderanmeldeinformationen sind falsch oder wurden nicht übergeben. |
| 500 | Interner Serverfehler. Beim Verarbeiten der Anforderung ist ein unerwarteter Fehler aufgetreten. Die Antwort enthält zusätzliche Informationen zum Fehler. |
[Tabelle : 6. Statuscodes]

### Antworttext-Parameter (JSON oder XML)

{#aggregate-GET-stats__entry__46}

| Name | Beschreibung |
|-|-|
| Hängt von der angegebenen Tabelle und den angegebenen Anforderungsparametern ab. |   |
[ ]

### Beispiel für Curl-Anforderung

    curl "https://instance.servicenow.com/api/now/stats/incident?sysparm_avg_fields=reassignment_count%2Cbusiness_stc&sysparm_group_by=assignment_group" \
    --request GET \
    --header "Accept:application/json" \
    --user "username":"password"

    {
      "result": [
        {
          "stats": {
            "avg": {
              "business_stc": "804162.7143",
              "reassignment_count": "1.0000"
            }
          },
          "groupby_fields": [
            {
              "value": "",
              "field": "assignment_group"
            }
          ]
        },
        {
          "stats": {
            "avg": {
              "business_stc": "2037371.0000",
              "reassignment_count": "1.5000"
            }
          },
          "groupby_fields": [
            {
              "value": "287ee6fea9fe198100ada7950d0b1b73",
              "field": "assignment_group"
            }
          ]
        },
        {
          "stats": {
            "avg": {
              "business_stc": "1821488.2857",
              "reassignment_count": "1.1111"
            }
          },
          "groupby_fields": [
            {
              "value": "8a5055c9c61122780043563ef53438e3",
              "field": "assignment_group"
            }
          ]
        },
        {
          "stats": {
            "avg": {
              "business_stc": "1730322.0000",
              "reassignment_count": "1.2500"
            }
          },
          "groupby_fields": [
            {
              "value": "287ebd7da9fe198100f92cc8d1d2154e",
              "field": "assignment_group"
            }
          ]
        },
        {
          "stats": {
            "avg": {
              "business_stc": "1564478.6250",
              "reassignment_count": "1.2500"
            }
          },
          "groupby_fields": [
            {
              "value": "d625dccec0a8016700a222a0f7900d06",
              "field": "assignment_group"
            }
          ]
        },
        {
          "stats": {
            "avg": {
              "business_stc": "1512202.2500",
              "reassignment_count": "1.1111"
            }
          },
          "groupby_fields": [
            {
              "value": "8a4dde73c6112278017a6a4baf547aa7",
              "field": "assignment_group"
            }
          ]
        }
      ]
    }


