---
sourceDocument: オーストラリア API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/api-reference

 Release :

    - australia

ft:locale :

    - ja-JP

ft:publication_title :

    - オーストラリア API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# アグリゲート API

# アグリゲート API {#ariaid-title1}

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

アグリゲート API は、既存のテーブルと列データに関するアグリゲート統計を計算できるエンドポイントを提供します。

この API は [GlideAggregate](https://servicenow-prod.fluidtopics.net/YH3MF48VxvVzg8O89GnOiw#c_GlideAggregateScopedAPI "GlideAggregate API を使用すると、データベース集計クエリを作成できます。") 呼び出しを使用し、ロール所有権に基づいて呼び出されるテーブルに読み取りアクセス権が定義されている場合にのみ、読み取り専用クエリーを受け入れます。

## アグリゲート:GET /now/stats/{tableName} {#ariaid-title2}

指定されたテーブルのレコードを取得し、戻り値に対して集計関数を実行します。
sysparm_\<aggregate\>_fieldsパラメーターまたはsysparm_having=\<aggregate\>\^field\^operator\^valueパラメーターのいずれかを使用して、実行する集計関数を指定し、次のいずれかの集計関数を\<aggregate\>で置き換えます。  
* 平均
* 最大
* 最小
* 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}  
注:  
使用可能なバージョン [は、REST API エクスプローラー](https://servicenow-prod.fluidtopics.net/5V9lEGssZWUBc2ao1C_~Fg "このチュートリアルでは、REST API エクスプローラーを使用して、 ServiceNow REST API をテストします。")で指定されます。スクリプト済み REST API の場合、\[ [スクリプト済み REST サービス\] フォーム](I8AGM_146DeZDBTS~H_J8g "スクリプト化された REST API 機能を使用すると、アプリケーション開発者はカスタム Web サービス API をビルドできます。")に追加のバージョン情報があります。

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

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

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

{#aggregate-GET-stats__entry__8}

| 名前 | 説明 |
|-|-|
| 名前と値のペア | sysparm_query パラメーターを使用する代わりに使用できます。キーがフィールドの名前であるキーと値のペアを使用して、クエリをフィルタリングできます。 たとえば、パラメーター `&sysparm_query=active=true` を使用する代わりに、 `&active=true` を使用できます。フィールドが選択肢タイプまたは参照タイプのフィールドである場合 (`&state=7` ではなく `&state=closed` など) に表示値を使用できます。複数のキーと値のペアを指定するには、それぞれをアンパサンドで区切ります ( `例:&active=true&assigned_to=john.smith`)。 データタイプ：文字列 |
| sysparm_\<アグリゲート\>_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` など) に従う必要があります。複数のクエリーを指定するには、それぞれをカンマで区切って指定できます ( `例:count^state^=^1,avg^priority^>^3`)。 データタイプ：文字列 |
| sysparm_order_by | グループ化された結果を並べ替える値のリスト。フィールドまたは集計を使用して順序を指定できます。たとえば、 `sysparm_order_by=AVG^state` を指定した場合、平均状態値が低い結果のグループが最初に返されます。COUNT で並べ替えて、各グループ内のレコード数でレコードのグループを並べ替えることもできます。 順序を指定すると、グループはデフォルトで昇順で並べ替えられます。降順でソートするには、 `^DESC` を使用します ( `例:sysparm_order_by=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/lLW_uT5I5_l1aD8yR4Jt9A "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/lLW_uT5I5_l1aD8yR4Jt9A "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-403-status-code}{#aggregate-GET-stats__entry-500-status-code}

| ステータスコード | 説明 |
|-|-|
| 200 | 成功。要求が正常に処理されました。 |
| 401 | 権限がありません。ユーザー認証情報が正しくないか、渡されていません。 |
| 403 | 禁止されました。ユーザーには、指定されたレコードへのアクセス権がありません。 |
| 500 | 内部サーバーエラー要求の処理中に予期しないエラーが発生しました。応答には、エラーに関する追加情報が含まれています。 |
[表 : 6. ステータスコード]

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

{#aggregate-GET-stats__entry__48}

| 名前 | 説明 |
|-|-|
| 指定されたテーブルと指定された要求パラメーターに依存します。 |   |
[ ]

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