Clicks by Group
This API retrieves click counts by link group for a specified date.
It returns a list where the clicks of all links within each group are summed up based on that date.
Each request can retrieve up to 30 groups at a time.
To view more groups, use the page parameter and make multiple requests.
This API is available starting from the Premium plan.
Http Header
GET /api/link/v1/clicks-by-group?ymd={ymd}&grpIdx={grpIdx}&pages={pages}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"ymd": "2025-08-01",
"grpIdx": "151,207,209",
"pages": 1
}| Fields | Field Descriptions | Description | Required | Type |
|---|---|---|---|---|
| ymd | Date | Enter the date in YYYY-MM-DD format. Example: 2025-08-01 | Date | |
| grpIdxList | Group IDX List | This is the list of group IDX values to query. Provide numeric IDX values separated by commas (,). Example: 101,102,103 If omitted, click data for all groups will be retrieved. In the Premium plan, you must specify the group IDX list, and up to 5 items can be included. | string | |
| pages | Page | Each request can retrieve up to 30 group click counts. If you need to fetch more, use the pages parameter to paginate requests.For example, if pages=2, the response will contain data for group 31 to 60. | int |
Response
{
"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
}
]
}
}| Fields | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| code | Response code (0: success) | int | ||||||||||||||||||||||||||||||||||||||||||||
| message | Included when the code is not 0. Contains an error message describing the reason for failure. | string | ||||||||||||||||||||||||||||||||||||||||||||
| result | extra (Pagination Info)
list - Array
| object |