メインコンテンツまでスキップ

アイテム件数分析

説明​

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

必要権限​

なし

URL​

POST /analytics/itemCounts

リクエストボディ​

名前型必須か説明
groupsGroup[]×集計の分析軸となるディメンションとグループ化の粒度を指定します。
filterByCondition○条件に合致した値を集計するための条件式を指定します。
filterScopestring×条件式のフィールドに organizationId が指定された場合のみ有効。それ以外は無視します。
所属組織または所属ユーザーグループでのフィルタにおいて、直接の所属か末端までのいずれかに所属するかの判定方法を指定します。

children：直属での判定
descendants：末端までのいずれかで判定
isCumulativeDataboolean×累積のデータを取得するか。

true：累積のデータとして取得します
false：差分のデータとして取得します

true を指定する場合、filterBy の条件式に期間の条件指定が必要です。

レスポンス​

名前型説明
factDataFactData集計結果

エラーケース​

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

特記事項​

本 API は 以下のいずれかの方が使用できます。

  • Professional エディションを利用中の方
  • Standard エディションを利用し、年間ライセンスご利用中の方

サンプル​

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

POST /analytics/itemCounts
Request Body
{
    "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"
                }
            }
        ]
    }
}
Response
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​

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

FactData​

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