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

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

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

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

GET

/api/link/v2/clicks-by-group?startYmd={startYmd}&endYmd={endYmd}&grpIdxList={grpIdxList}&pages={pages} 


GET /api/link/v2/clicks-by-group
     ?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
このグループ内のリンクをクリックしたユニークユーザー数。

このAPIを利用する場面

複数のキャンペーングループの成果を日付単位で比較したい場合に利用します。

グループごとの総クリック数とユニークユーザー数を1回のリクエストで集計でき、キャンペーン比較やグループ別トラフィック分析に適しています。

単なる取得ではなく、成果の比較分析に活用されます。

他のクリックAPIとの違い

時間 → 「いつ」、日付 → 「変化」、グループ → 「どこから」
グループAPIは成果比較に最適化されています。

複数グループの同時取得方法

grpIdxListにグループIDXをカンマ（,）区切りで指定すると、複数グループを1回のリクエストで取得できます。
例：151,207,209。1回のリクエストで最大30グループまで取得可能で、それ以上はpagesを使用して複数回呼び出します。

grpIdxListの省略可否はプランによって異なります。
プレミアムプランでは指定が必須で、最大5件まで設定可能です。
ビジネスプランでは省略時に全グループが返され、件数制限なく指定できます。

活用例

  • キャンペーン比較: grpIdxListに複数グループを指定し、一括で成果を比較
  • 月次トラフィック分析: startYmdとendYmdで期間を指定し、グループ別クリック総数を把握
  • イベント比較: （ビジネスプラン以上）grpIdxListを省略して全体データを取得し、上位グループを分析
  • ダッシュボード構築: ページングを巡回して全データを収集し、内部分析に活用

利用時の注意点

  • グループ数が多い場合はページング処理が必要になります。
  • データ量が多い場合、レスポンス時間が長くなる可能性があります。
  • 取得可能な最大期間はプランによって異なります。パーソナルプランは最大7日、プレミアムプランは最大14日です。
  • 1ページあたり最大30グループが返されます。全体が30件を超える場合は、pagesを増やして追加取得してください。