Clicks by Group

API to retrieve click counts by link group for a specified date.

Returns a list with the total clicks aggregated for all links within each group.

A maximum of 30 groups can be retrieved per request. To query more groups, use the pages parameter and call the API multiple times.

This API is available on Premium plans or higher.

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
Reference date for the query. Example: 2025-08-01
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.