グループ別クリック数
指定した日付を基準に、リンクグループごとのクリック数を取得するAPIです。
各グループに属するリンクのクリック数を合算し、一覧形式で返します。
1回のリクエストで最大30グループまで取得可能です。 それ以上を取得する場合は、pagesパラメータを使用して複数回呼び出してください。
このAPIはプレミアムプラン以上で利用可能です。
GET
/api/link/v1/clicks-by-group?ymd={ymd}&grpIdxList={grpIdxList}&pages={pages}
{
"ymd": "2025-08-01",
"grpIdxList": "151,207,209",
"pages": 1
}Request Parameters
- ymddaterequired
- 照会基準日。例: 2025-08-01
- grpIdxListstring
照会するグループのIDX一覧をカンマ(,)で区切って指定します。例: 151,207,209
プレミアムプラン: グループIDX一覧を必ず指定する必要があり、最大5件まで指定できます。ビジネスプラン: グループIDX一覧を省略すると全グループのクリック数が照会され、件数制限なく指定することも可能です。
- pagesintegerrequired
- 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
- codeinteger
- 応答コード: 0 = 成功、それ以外 = エラー
- messagestring
- 応答メッセージです。応答コードが0でない場合、エラーメッセージが返されます。
- resultobject
- extraobject
- ページおよびデータ件数情報。
- pagesinteger
- 現在のページ番号
- nextPagesinteger
- 次のページ番号
- nextYnstring
- 次のページが存在するかどうか
- countinteger
- 現在のページのデータ件数
- totalCountinteger
- 全データ件数
- listarray
- グループ別クリック数
- grpIdxinteger
- リンクグループ（IDX）。
- grpNmstring
- リンクグループ名。
- acesCntinteger
- このグループに属するリンクの総クリック数。
- pernCntinteger
- このグループ内のリンクをクリックしたユニークユーザー数。