クエリインサイト
インサイトリクエストの計算結果。インサイトエントリのリストとして返されます。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
insights | array of クエリのインサイトエントリ | はい | 計算されたインサイトエントリのリスト。各エントリは、グループ、データセット全体、または上位の結果に含まれないグループの集合に対応しています。 |
例
{
"insights": [
{
"key": [
"ContractType1"
],
"type": "group",
"metrics": {
"totalContractValue": {
"type": "sum",
"values": {
"sum": 180000
}
},
"countContractType": {
"type": "count",
"values": {
"count": 245
}
}
}
},
{
"key": [
"ContractType4"
],
"type": "group",
"metrics": {
"totalContractValue": {
"type": "sum",
"values": {
"sum": 100000
}
},
"countContractType": {
"type": "count",
"values": {
"count": 185
}
}
}
},
{
"key": [
"ContractType2"
],
"type": "group",
"metrics": {
"totalContractValue": {
"type": "sum",
"values": {
"sum": 200000
}
},
"countContractType": {
"type": "count",
"values": {
"count": 150
}
}
}
},
{
"key": [],
"type": "other",
"metrics": {
"totalCountBeyondTopGroups": {
"type": "count",
"values": {
"count": 165
}
}
}
}
]
}
クエリのインサイトエントリ
グループ化キー (該当する場合) と計算された指標を含む、計算された単一のインサイトエントリ。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
key | array of string | はい | エントリに関連付けられたグループ化キーの値。groupエントリのgroup_byフィールドごとに1つの値が含まれます。overallエントリとotherエントリの場合は、値が空になります。 |
type | enum<string> | はい | 関連付けられた指標の集計方法を示す、インサイトエントリの種類。 使用可能なオプション: group, overall, other. |
metrics | object | はい | 指標エイリアスの計算結果へのマップ。otherエントリの場合、数はtotalCountBeyondTopGroupsキーで報告されます。 |
例
{
"key": [
"ContractType1"
],
"type": "group",
"metrics": {
"totalContractValue": {
"type": "sum",
"values": {
"sum": 180000
}
},
"countContractType": {
"type": "count",
"values": {
"count": 245
}
}
}
}
クエリの結果
マイルストーンベースのマーカーページネーションを使用した、クエリに一致する項目のページ割りされたリスト。属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
entries | array of クエリの結果のエントリ | はい | クエリの述語に一致する項目のリスト。 |
next_marker | string | はい | 次の結果ページの開始を示すマーカー。nullの場合、追加で表示できる結果はありません。 null を指定できます。 |
limit | integer | はい | このリクエストに使用された制限。許容される最大値を超えていない限り、クエリパラメータのlimitと等しくなります。 |
例
{
"entries": [
{
"id": "12345",
"type": "file",
"box": {
"item": {
"name": "My Form"
}
},
"enterprise_12345678": {
"book": {
"$parent": "file_12345",
"$scope": "enterprise_12345678",
"$template": "book",
"$version": 4,
"isbn": "1871263670",
"purchasePrice": 234.57,
"publicationYear": "1937"
}
}
}
],
"next_marker": "xppy0jjG1kBRSc7NBBSgQmBz1Gk6VaQdg5Vyb+Ob0iA=",
"limit": 1
}
クエリの結果のエントリ
クエリに一致する単一の項目。項目のtypeとidが常に含まれます。リクエストでfieldsパラメータが指定されていた場合は、追加の項目またはメタデータフィールドが返されます。
属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
id | string | はい | 一致する項目の一意の識別子。 |
type | string | はい | 一致する項目の種類。 |
例
{
"id": "12345",
"type": "file"
}