Clicks by Group API (v2)

Retrieve click counts by link group for a specific date.

This API aggregates clicks across all links within each group and returns them as a list.
Compare multiple groups at once to evaluate campaign performance at a glance.

This API is available on the Personal plan and above.

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
Start date of the query (e.g. 2025-12-01)
endYmd date required
End date of the query (e.g. 2025-12-31). The maximum range between the start and end dates is 1 month.
Personal plan: up to 7 days
Premium plan: up to 14 days
grpIdxList string

Provide the list of group IDX values separated by commas (,). Example: 151,207,209

  • Premium plan: You must specify the group IDX list, up to 5 groups allowed.
  • Business plan: If omitted, clicks from all groups are retrieved. You can also specify any number of groups without limitation.
pages integer required
Default:1
Page number of the results.
Each page returns 30 results by default. For example, if pages=2, results from the 31st record onward will be returned (30 records). 
{
    "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
Response code: 0 = Success, other values = Error
message string
Response message. If the response code is not 0, an error message is returned.
result object
extra object
Page and data count information.
pages integer
Current page number
nextPages integer
Next page number
nextYn string
Whether there is a next page
count integer
Number of records on the current page
totalCount integer
Total number of records
list array
Clicks by Group
grpIdx integer
Link group (IDX).
grpNm string
Link group name.
acesCnt integer
Total number of clicks for all links in this group.
pernCnt integer
Number of unique users who clicked links in this group.

When to Use This API

Use this API to compare the performance of multiple campaign groups on a given date.

It aggregates total clicks and unique users per group in a single request, making it ideal for campaign comparison and group-level traffic analysis.

It goes beyond simple retrieval and enables comparative performance analysis.

Difference from Other Click APIs

Time → “when”, Date → “trend”, Group → “source”
The Group API is optimized for performance comparison.

How to Query Multiple Groups

You can query multiple groups in a single request by passing group IDX values in grpIdxList, separated by commas (,).
Example: 151,207,209. You can request up to 30 groups per call. For more, use the pages parameter and make additional requests.

Whether grpIdxList can be omitted depends on your plan.
On the Premium plan, it must be specified and supports up to 5 groups.
On the Business plan, omitting it returns all groups, with no limit on the number specified.

Use cases

  • Compare campaign performance: Provide multiple group IDX values in grpIdxList to compare results in a single request
  • Monthly group traffic analysis: Use startYmd and endYmd to analyze total clicks per group over a month
  • Compare event performance: (Business+) Omit grpIdxList to retrieve all groups and rank top performers
  • Build dashboards: Iterate through pages to collect all group data for internal analytics dashboards

Things to consider

  • Pagination is required when querying a large number of groups.
  • Response time may increase with larger datasets.
  • The maximum date range depends on your plan. Personal: up to 7 days, Premium: up to 14 days.
  • Up to 30 groups are returned per page. If the total exceeds 30, increase pages to retrieve additional results.