グループ別クリック数 (v2)
指定した日付を基準に、リンクグループごとのクリック数を取得するAPIです。
各グループに属するリンクのクリック数を合算し、一覧形式で返します。
1回のリクエストで最大30グループまで取得可能です。 それ以上を取得する場合は、pagesパラメータを使用して複数回呼び出してください。
このAPIはプレミアムプラン以上で利用可能です。
/api/link/v2/clicks-by-group?startYmd={startYmd}&endYmd={endYmd}&grpIdxList={grpIdxList}&pages={pages}
{
"startYmd": "2025-08-01",
"endYmd": "2025-08-31",
"grpIdxList": "151,207,209",
"pages": 1
}Request Parameters
- startYmd date required
- 検索開始日（例：2025-12-01）
- endYmd date required
-
検索終了日（例：2025-12-31）。開始日と終了日の最大範囲は1か月です。
パーソナルプラン：最大7日
プレミアムプラン：最大14日 - grpIdxList string
-
照会するグループのIDX一覧をカンマ(,)で区切って指定します。例: 151,207,209
プレミアムプラン: グループIDX一覧を必ず指定する必要があり、最大5件まで指定できます。ビジネスプラン: グループIDX一覧を省略すると全グループのクリック数が照会され、件数制限なく指定することも可能です。
- pages integer required
- Default:1
-
ページ番号。照会結果のページ番号です。
1ページあたりデフォルトで30件が返されます。 例: pages=2の場合、31件目から30件が返されます。
{
"code": 0,
"message": "",
"result": {
"extra": {
"pages": 1,
"nextPages": 1,
"nextYn": "N",
"count": 3,
"totalCount": 3
},
"list": [
{
"grpIdx": 151,
"grpNm": "Electronics",
"acesCnt": 181,
"pernCnt": 164
},
{
"grpIdx": 207,
"grpNm": "Kitchenware",
"acesCnt": 19847,
"pernCnt": 18095
},
{
"grpIdx": 209,
"grpNm": "Brian Smith Advertiser Only",
"acesCnt": 5730,
"pernCnt": 5409
}
]
}
}Response Parameters
- code integer
- 応答コード: 0 = 成功、それ以外 = エラー
- message string
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- result object
- extra object
- ページおよびデータ件数情報。
- pages integer
- 現在のページ番号
- nextPages integer
- 次のページ番号
- nextYn string
- 次のページが存在するかどうか
- count integer
- 現在のページのデータ件数
- totalCount integer
- 全データ件数
- list array
- グループ別クリック数
- grpIdx integer
- リンクグループ（IDX）。
- grpNm string
- リンクグループ名。
- acesCnt integer
- このグループに属するリンクの総クリック数。
- pernCnt integer
- このグループ内のリンクをクリックしたユニークユーザー数。