Query リソース

リソース URL

1/wave/query

形式

JSON

使用可能なバージョン

36.0

HTTP のメソッド

POST

POST のリクエストボディ

パラメータ名	型	説明	必須項目/省略可能	使用可能なバージョン
query	Object (Saql​Query​Input​Representation)	JSON 形式のクエリ。	必須項目	36.0

リクエストボディの例

1{
2    "query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";
3     q = group q by 'FirstName';
4     q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';
5     q = limit q 2000;"
6}

POST のレスポンスボディ

説明	検索条件グループとバージョン	使用可能なバージョン
SAQL クエリの結果 (JSON 形式)。グルーピングと列の型/名前を説明する metadata が含まれる場合もあります。レスポンスボディの例とクエリの metadata が説明されているセクションを参照してください。	Small、36.0	36.0

SaqlQueryInputRepresentation

プロパティ名	型	説明	必須項目/省略可能	使用可能なバージョン
name	String	クエリ名。	必須項目	41.0
query	String	クエリ。	必須項目	36.0

レスポンスボディの例 (metadata を含まない)

1{
2  "action":"query",
3  "responseId":"3vy-E9YmX-TIWe0769juD-",
4  "results": {
5    "records":[
6      {"FirstName":"","count":1},
7      {"FirstName":"Admin","count":1},
8      {"FirstName":"Integration","count":1},
9      {"FirstName":"Security","count":1}
10    ]
11  },
12  "query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";
13           q = group q by 'FirstName';
14           q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';
15           q = limit q 2000;",
16  "responseTime":544
17}

レスポンスボディの例 (metadata を含む)

1{
2  "action":"query",
3  "responseId":"3vy-E9YmX-TIWe0769juD-",
4  "results": {
5    "metadata": {
6      "columns":[
7        {"name":"FirstName", "type":"String"},
8        {"name":"count", "type":"Numeric"}
9      ],
10      "groups":["FirstName"]
11    },
12    "records":[
13      {"FirstName":"","count":1},
14      {"FirstName":"Admin","count":1},
15      {"FirstName":"Integration","count":1},
16      {"FirstName":"Security","count":1}
17    ]
18  },
19  "query":"q = load \"0Fbxx0000000006CAA/0Fcxx000000001dCAA\";
20           q = group q by 'FirstName';
21           q = foreach q generate 'FirstName' as 'FirstName', count() as 'count';
22           q = limit q 2000;",
23  "responseTime":544
24}

クエリの metadadta

クライアントは SAQL クエリを解析し、使用されているディメンションとグループを判断できますが、コストが高くなる可能性があります。そのためほとんどの場合、クエリ応答には metadata セクションが含まれ、このセクションでグルーピングと列情報が提供されます。metadata セクションが存在する場合は、クエリ応答ペイロードの結果キーで見つけることができます。metadata セクションは、columns キーと groups キーで構成されます。

1"metadata":{
2  "columns":[{"name":"dim name", "type":"String"}],
3  "groups":["name","destination"]
4}

columns キーには、クエリの射影の名前と型が含まれます。groups キーには、クエリで使用されるグループのリストが含まれます。

• metadata は、クエリが成功したときに追加されます。クエリの実行が失敗した場合、構文エラーがある場合、または認証コールバックが失敗した場合、metadata は結果に追加されません。
• 列名に設定される値は、ディメンションの名前ではなく射影に付けられた別名です。
• クエリが複雑ではなく、返されるグループ名が非決定的な (グループの名前がクエリの複数のストリームで使用されている) 場合、クエリで使用されるグループのリストが groups キーで返されます。これは、クエリが cogroup または union を使用する場合です。そのような場合、groups キーは空になります。

メモ

SAQL クエリの作成についての詳細は、『Analytics SAQL リファレンス』および『Analytics SDK Guide (Analytics SDK ガイド)』を参照してください。