Clicks by Hour
This API retrieves the number of clicks per hour (00:00 to 23:00) for a specified date.
The target of the query varies depending on the request:
- If both linkId + domain are provided, it returns hourly click counts for that specific link.
- If groupIdx is included, it returns the total clicks for all links within that group.
- If neither is included, it returns hourly click counts for the entire account.
This API helps analyze how click traffic is distributed throughout the day for a given date,
and is useful for evaluating event performance, identifying peak marketing hours, and understanding user behavior patterns.
This API is available starting from the Personal plan.
Http Header
GET /api/statistics/v2/clicks-by-hour?ymd={ymd}
Host: https://vivoldi.com
Authorization: APIKey {Your API Key}
Content-type: -
User-agent: {Your User-agent}
Accept-Language: en
Request
{
"ymd": "2025-04-20"
}| Fields | Field Descriptions | Description | Required | Type |
|---|---|---|---|---|
| ymd | Date | Example: 2025-04-20 | Date | |
| linkId | Link ID | If the link ID contains special characters or Unicode, it must be URL-encoded. For the Personal plan, both the link ID and domain must be included, and only click data for individual links can be retrieved. Starting from the Premium plan, link ID and domain fields are optional. | string | |
| domain | Domain | If the link ID is manually set, the domain is “https://vvd.im” instead of “https://vvd.bz”. Also, if the link was created with a custom domain, you must specify that custom domain in the request to retrieve data correctly. | string | |
| grpIdx | Group IDX | If a group IDX is specified, the total number of clicks from all links within that group will be returned. This field is available starting from the Premium plan. If specified in the Personal plan, it will be ignored. | int |
Response
{
"code": 0,
"message": "",
"result": [
{
"ymd": "2025-04-20",
"hour": 0,
"acesCnt": 24,
"pernCnt": 17
},
{
"ymd": "2025-04-20",
"hour": 1,
"acesCnt": 121,
"pernCnt": 198
},
{
"ymd": "2025-04-20",
"hour": 2,
"acesCnt": 84,
"pernCnt": 68
},
{
"ymd": "2025-04-20",
"hour": 3,
"acesCnt": 21,
"pernCnt": 15
},
{
"ymd": "2025-04-20",
"hour": 4,
"acesCnt": 1950,
"pernCnt": 1621
},
{
"ymd": "2025-04-20",
"hour": 5,
"acesCnt": 7,
"pernCnt": 7
}
]
}| 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 |
| array |