Clicks by Hour

API to retrieve hourly clicks for a specified date (00:00–23:59).

Query conditions

  • Both linkId + domain specified → Retrieve hourly clicks for that link.
  • grpIdx specified → Retrieve total hourly clicks for links in that group.
  • No condition → Retrieve hourly clicks for the entire account.

This API is used to analyze click traffic distribution on a specific date.
Useful for event performance measurement, identifying peak marketing hours, and analyzing user activity patterns.

This API is available on Personal plans or higher.

GET

/api/statistics/v2/clicks-by-hour?ymd={ymd}

{
    "ymd": "2025-04-20"
}

Request Parameters

ymddaterequired
Reference date for the query. Example: 2025-04-20
linkIdstring
Link ID. If it contains special characters or Unicode, URL encoding is required.
Personal plan: linkId and domain are required, only individual link clicks can be retrieved.
Premium plans or higher: optional input.
domainstring
Link domain.
grpIdxinteger
Link group. The group IDX can be obtained by calling the Group List API or checking in the dashboard.
If specified, the total click count of all links in that group will be returned. Available only on Premium plans or higher.
{
    "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
        }
    ]
}

Response Parameters

codeinteger
Response code: 0 = Success, any other value = Error
messagestring
Response message. If the response code is not 0, an error-related message is returned.
resultarray
ymddate
Date.
hourinteger
Hour (0–23).
acesCntinteger
Total clicks during the specified time period.
pernCntinteger
Number of unique users who clicked links during that time period.