アイテム件数分析

説明

アイテム件数ファクトとディメンションにクエリを行うことで分析データを取得します。
パラメータの詳細は「分析APIのファクトとディメンション」、「条件式の使い方」を参照してください。

必要権限

なし

URL

POST /analytics/itemCounts

リクエストボディ

名前	型	必須か	説明
groups	Group[]	×	集計の分析軸となるディメンションとグループ化の粒度を指定します。
filterBy	Condition	○	条件に合致した値を集計するための条件式を指定します。
filterScope	string	×	条件式のフィールドに organizationId が指定された場合のみ有効。それ以外は無視します。所属組織または所属ユーザーグループでのフィルタにおいて、直接の所属か末端までのいずれかに所属するかの判定方法を指定します。 children：直属での判定 descendants：末端までのいずれかで判定
isCumulativeData	boolean	×	累積のデータを取得するか。 true：累積のデータとして取得します false：差分のデータとして取得します true を指定する場合、filterBy の条件式に期間の条件指定が必要です。

レスポンス

名前	型	説明
factData	FactData	集計結果

エラーケース

条件式の比較演算子の右オペランドにフィールドを指定した
ディメンションが未指定
ディメンションが値域外
グループ化の粒度が未指定
グループ化の粒度が値域外
条件式の演算子の種類が値域外
条件式の比較演算子の左オペランドが存在しない
条件式の比較演算子の右オペランドが存在しない
条件式のオペランドの種類が値域外
条件式のフィールド名が空
条件式の指定したフィールドが存在しない
条件式の比較演算子の左オペランドと右オペランドの型が一致しない
累積のデータを取得する場合に条件式に期間の条件が指定されていない

特記事項

本 API は Professional エディションでのみ使用可能です。

サンプル

プロジェクト内の月別のアイテム件数の取得する

リクエスト

POST /analytics/itemCounts

{
    "groups": [
        {
            "name": "date",  
            "granularity": "month"  
        },
        {
            "name": "project",  
            "granularity": "project"  
        }
    ],
    "filterBy": {
        "type": "And",
        "children": [
            {
                "type": "Eq",
                "left": {
                    "name": "projectId",  
                    "type": "field"
                },  
                "right": {  
                    "type": "value",  
                    "value": "6"
                }
            },
            {
                "type": "Ge",
                "left": {
                    "type": "field",
                    "name": "date"
                },
                "right": {
                    "type": "value",
                    "value": "2018/8/01"
                }
            },
            {
                "type": "Le",
                "left": {
                    "type": "field",
                    "name": "date"
                },
                "right": {
                    "type": "value",
                    "value": "2019/01/31"
                }
            }
        ]
    }
}

レスポンス

200 OK

{
    "factData":[
        {
            "values":{
                "date":"2018/11/01 0:00:00",
                "projectId":"6",
                "projectName":"S機器の開発",
                "itemCount":"23"
            }
        },
        {
            "values":{
                "date":"2018/12/01 0:00:00",
                "projectId":"6",
                "projectName":"S機器の開発",
                "itemCount":"24"
            }
        },
        {
            "values":{
                "date":"2019/01/01 0:00:00",
                "projectId":"6",
                "projectName":"S機器の開発",
                "itemCount":"25"
            }
        }
    ]
}

型定義

Group

名前	型	必須か	説明
name	string	○	ディメンション表の名前
granularity	string	○	グループ化の粒度

FactData

名前	型	必須か	説明
values	<string, string>	○	集計結果のフィールドと値