グループ別クリック数取得API (v1)

指定した日付を基準に、リンクグループごとのクリック数を取得するAPIです。

各グループに属するリンクのクリック数を合算し、一覧形式で返します。
複数のグループを同時に比較し、キャンペーンごとの成果を把握できます。

このAPIはパーソナルプラン以上で利用可能です。

v1（レガシー）ドキュメントです。

新規連携には、最新バージョンである v2 のご利用を推奨します。
v1 は既存連携を維持するためのバージョンであり、新機能や改善は提供されません。

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

ymd date required
照会基準日。例: 2025-08-01
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
このグループ内のリンクをクリックしたユニークユーザー数。