---
title: "Query Analysis Group By Count"
slug: "analytics-cloudsearch-analysisgroupbycount"
updated: 2026-09-17T09:57:26Z
published: 2026-09-17T09:57:26Z
canonical: "api.ncloud-docs.com/analytics-cloudsearch-analysisgroupbycount"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Query Analysis Group By Count

使われた検索Queryを分析してfield別にGroup ByされたCount集計を行います。

- city1: 都市区分フィールド1 ex) ソウル特別市、京畿道、忠清北道
- city2: 都市区分フィールド2 ex) 江南区、瑞草、九老区
- city3: 都市区分フィールド2 ex) ヨクサン洞、ジョンジャ洞、ソチョ洞
- country: 国家
- word: 検索Queryを形態素解析したword

```
POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/{name}/analysis/count_group_by
```

## リクエスト

### リクエストパラメータ

| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
| --- | --- | --- | --- | --- |
| name | Yes | string |  | 作成されているDomain名 |

### リクエストボディ

| パラメータ名 | 必須 | タイプ | 制約事項 | 説明 |
| --- | --- | --- | --- | --- |
| from | Yes | string |  | 開始時間(UTC, ex: 20161027T171340Z ) |
| to | Yes | string |  | 終了時間(UTC, ex: 20161027T171340Z ) |
| groupBy | Yes | [GroupBySchema](/docs/ja/common-apidatatype-csanalysisgroupnyschema) |  | groupBy設定 |
| aggregate | Yes | [AggregateSchema](/docs/ja/common-apidatatype-csanalysisaggregatebyschema) |  | aggregate設定 |

## レスポンス

### Success

```
[
  {
    "key": (string),
    "doc_count": (int),
    "aggregated_result": {
      "sum_other_doc_count": (int),
      "buckets": [
        {
          "key": (string),
          "doc_count": (int),
        }
      ]
    }
  }
]
```

## レスポンス

| フィールド名 | タイプ | 説明 | 備考 |
| --- | --- | --- | --- |
| key | string | Group byされた結果の基準値 |  |
| doc_count | number | 基準値に該当するすべての値の合計 |  |
| aggregated_result.sum_other_doc_count | number | aggregate結果が指定したmax_size値より大きい場合、結果に出力されてないすべての値の合計 |  |
| aggregated_result.buckets[] | array | aggreagte結果のkey別のグルーピング |  |
| aggregated_result.buckets[].key | string | 該当時間の間、queryに使われたfieldの値 |  |
| aggregated_result.buckets[].doc_count | string | 該当時間の間、queryに使われたkeyの回数 |  |

### レスポンス Status

| Http Status | Desc |
| --- | --- |
| 200 | OK(リクエスト完了) |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |

## 例示

### 例示1 : field_valueがある場合

#### リクエスト

```
POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car_dev/analysis/count_group_by

POST /CloudSearch/real/v1/domain/car_dev/analysis/count_group_by HTTP/1.1
Host:cloudsearch.apigw.ntruss.com
accept:application/json
x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "from": "2019-09-25T05:00:00Z",
  "to": "2019-09-25T15:00:00Z",
  "groupBy": {
    "field": "word",
    "field_value": "Hyundai",
    "max_size": 10
  },
  "aggregate": {
    "field": "city1",
    "max_size": 10
  }
}
```

#### レスポンス 例示

```
[
  {
    "key": "Hyundai",
    "doc_count": 1,
    "aggregated_result": {
      "sum_other_doc_count": 0,
      "buckets": [
        {
          "key": "京畿道",
          "doc_count": 1
        }
      ]
    }
  }
]
```

### 例示2 : field_valueがない場合

#### リクエスト

```
POST https://cloudsearch.apigw.ntruss.com/CloudSearch/real/v1/domain/car_dev/analysis/count_group_by

POST /CloudSearch/real/v1/domain/car_dev/analysis/count_group_by HTTP/1.1
Host:cloudsearch.apigw.ntruss.com
accept:application/json
x-ncp-apigw-signature-v2: cDwtHuQeGmwWyNmwlN6XIGA66zge4iMXvfoDQNna05g=
x-ncp-apigw-timestamp: 1545817618751
x-ncp-iam-access-key: teGTwtcSEGA7fu28BGGi

{
  "from": "2019-09-25T05:00:00Z",
  "to": "2019-09-25T15:00:00Z",
  "groupBy": {
    "field": "word",
    "maxSize": 10
  },
  "aggregate": {
    "field": "city1",
    "maxSize": 10
  }
}
```

#### レスポンス 例示

```
[
  {
    "key": "class",
    "doc_count": 3117,
    "aggregated_result": {
      "sum_other_doc_count": 357,
      "buckets": [
        {
          "key": "ソウル特別市",
          "doc_count": 1378
        },
        {
          "key": "京畿道",
          "doc_count": 473
        },
        {
          "key": "",
          "doc_count": 300
        },
        {
          "key": "仁川広域市",
          "doc_count": 119
        },
        {
          "key": "大邱広域市",
          "doc_count": 107
        },
        {
          "key": "釜山広域市",
          "doc_count": 104
        },
        {
          "key": "慶尚北道",
          "doc_count": 83
        },
        {
          "key": "全羅北道",
          "doc_count": 69
        },
        {
          "key": "大田広域市",
          "doc_count": 64
        },
        {
          "key": "慶尚南道",
          "doc_count": 63
        }
      ]
    }
  },
  {
    "key": "bmw",
    "doc_count": 3027,
    "aggregated_result": {
      "sum_other_doc_count": 303,
      "buckets": [
        {
          "key": "ソウル特別市",
          "doc_count": 1295
        },
        {
          "key": "京畿道",
          "doc_count": 515
        },
        {
          "key": "",
          "doc_count": 331
        },
        {
          "key": "仁川広域市",
          "doc_count": 127
        },
        {
          "key": "大邱広域市",
          "doc_count": 105
        },
        {
          "key": "釜山広域市",
          "doc_count": 88
        },
        {
          "key": "慶尚北道",
          "doc_count": 79
        },
        {
          "key": "大田広域市",
          "doc_count": 63
        },
        {
          "key": "全羅北道",
          "doc_count": 63
        },
        {
          "key": "全羅南道",
          "doc_count": 58
        }
      ]
    }
  }
]
```