---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# 集計 API

# 集計 API {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：8分

集計 API は、既存のテーブルと列のデータに関する集計統計情報の計算を可能にするエンドポイントを提供します。

集計 API 要求の場合は、クエリ対象のテーブル内のすべてのレコードに対する読み取りアクセス権が必要です。ACL のために、要求元ユーザーがテーブル内のレコードにアクセスできない場合、要求は 403 Forbidden エラーを返します。

## 集計 - GET /now/stats/{tableName} {#ariaid-title2}

指定されたテーブルのレコードを取得し、返された値に対して集計関数を実行します。
\<aggregate\> を次のいずれかの集計関数に置き換えて、sysparm_\<aggregate\>_fields パラメーターまたは sysparm_having=\<aggregate\>\^field\^operator\^value パラメーターのいずれかを使用して、実行する集計関数を指定できます。  
* avg
* max
* min
* sum
{#aggregate-GET-stats__ul_yyv_vcn_yq}

### URL 形式 {#aggregate-GET-stats__section_qsm_m1r_cmb}

バージョニングされた URL：/api/now/{api_version}/stats/{tableName}

デフォルトの URL：/api/now/stats/{tableName}

### サポートされている要求パラメーター

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

| 名前 | 説明 |
|-|-|
| api_version | オプションアクセスするエンドポイントのバージョン。たとえば、<kbd class="ph userinput">v1</kbd> や <kbd class="ph userinput">v2</kbd>。最新以外のエンドポイントバージョンを使用する場合にのみ、この値を指定してください。 データタイプ：文字列 |
| tableName | レコードを取得するテーブルの名前。 データタイプ：文字列 |
[表 : 1. パスパラメーター]

{#aggregate-GET-stats__entry__8}

| 名前 | 説明 |
|-|-|
| name-value pairs | sysparm_query パラメーターの使用に代わるものです。キーがフィールドの名前である場合、キー値のペアを使用してクエリをフィルタリングできます。 たとえば、`&sysparm_query=active=true` パラメーターを使用する代わりに、`&active=true` を使用できます。フィールドが選択フィールドや参照タイプフィールドの場合に、表示値を使用できます (`&state=7` の代わりに `&state=closed` など)。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります (`&active=true&assigned_to=john.smith` など)。 データタイプ：文字列 |
| sysparm_\<aggregate\>_fields | 各集計操作を実行するフィールドのリスト。複数のフィールドを指定するには、それぞれをカンマで区切ります。たとえば、期間フィールドと優先度フィールドから平均値を取得するには、`sysparm_avg_fields=duration,priority` を使用します。 注: クエリが意味のある結果を返すには、このパラメーター、sysparm_count パラメーター、またはその両方を指定します。どちらのパラメーターも渡されない場合、集計操作は実行されません。 データタイプ：文字列 |
| sysparm_count | クエリで返されたレコードの数を返すかどうかを決定するフラグ。 注: クエリが意味のある結果を返すには、このパラメーター、sysparm_\<aggregate\>_fields パラメーター、またはその両方を指定します。どちらのパラメーターも渡されない場合、集計操作は実行されません。 データタイプ：文字列 |
| sysparm_display_value | 参照フィールドまたは選択フィールド別にグループ化するときのデータ取得操作。この値に基づいて、クエリでデータベースの表示値、実際の値、またはその両方が返されます。 * true：すべてのフィールドの表示値が返されます。 * false：データベースから実際の値が返されます。値が指定されていない場合、このパラメーターはデフォルトで false に設定されます。 * all：実際の値と表示値の両方が返されます。 {#aggregate-GET-stats__ul_eyx_ccn_yq}このパラメーター設定に推奨方法はありません。ただし、表示値を指定すると、データベースから読み取られず、その他のフィールドやレコードを参照することがあるため、パフォーマンスの問題が発生する可能性があります。表示値と実際の値の詳細については、「[テーブル API FAQ (KB0534905)](https://support.servicenow.com/kb_view.do?sysparm_article=KB0534905)」を参照してください。 データタイプ：文字列 |
| sysparm_group_by | 返されたデータのグループ化の基準となるフィールド。複数のフィールドを指定するには、各フィールドをカンマで区切ります (`sysparm_group_by=priority,state` など)。 データタイプ：文字列 |
| sysparm_having | 集計操作に基づくデータのフィルタリングを可能にする追加のクエリ。優先度が 3 を超えるクエリ結果内のレコードの数を取得するために、このパラメーターの値は `aggregate^field^operator^value` の構文に従う必要があります (`count^priority^>^3` など)。複数のクエリを指定するには、それぞれをカンマで区切ります (`ascount^state^=^1,avg^priority^>^3` など)。 データタイプ：文字列 |
| sysparm_orderby | グループ化された結果の順序付けの基準となる値のリスト。フィールドまたは集計を使用して順序を指定できます。たとえば、`sysparm_orderby=AVG^state` を指定すると、平均ステータス値が低い結果のグループが最初に返されます。COUNT で並べ替えて、各グループのレコード数でレコードのグループを配置することもできます。 順序を指定すると、グループはデフォルトで昇順に並べられます。降順でソートするには、`^DESC` を使用します (`sysparm_orderby=state^DESC` など)。 データタイプ：文字列 |
| sysparm_query | エンコードされたクエリ。 例：`(sysparm_query=active=true)(sysparm_query=caller_id=javascript:gs.getUserID()^active=true)` データタイプ：文字列 |
[表 : 2. クエリパラメーター]

{#aggregate-GET-stats__entry__26}

| 名前 | 説明 |
|-|-|
| なし |   |
[表 : 3. 要求本文パラメーター (XML または JSON)]

### ヘッダー

次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 [サポートされている REST API ヘッダー](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#aggregate-GET-stats__entry__30}{#aggregate-GET-stats__accept-RESTAPI}

| ヘッダー | 説明 |
|-|-|
| 承認 | 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。 デフォルト： application/json |
[表 : 4. 要求ヘッダー]

{#aggregate-GET-stats__entry__34}

| ヘッダー | 説明 |
|-|-|
| なし |   |
[表 : 5. 応答ヘッダー]

### ステータスコード

この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 [REST API HTTP 応答コード](https://servicenow-prod.fluidtopics.net/ldF_qFEQnejbeXLBxcUhWg "REST (REpresentational State Transfer) は、Web 上のコンピューターシステム間の標準を提供し、相互の通信を容易にするシンプルなステートレスアーキテクチャです。")」を参照してください。
{#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}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー資格情報が間違っているか、渡されていません。 |
| 500 | 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。 |
[表 : 6. ステータスコード]

### 応答本文のパラメーター (JSON または XML)

{#aggregate-GET-stats__entry__46}

| 名前 | 説明 |
|-|-|
| 指定されたテーブルと指定された要求パラメーターに応じて異なります。 |   |
[ ]

### サンプル cURL 要求

    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"
            }
          ]
        }
      ]
    }