Hourly Click Analytics API (v3)
Retrieve hourly click counts (00:00–23:59) for a selected date range.
Analyze hourly traffic distribution for a specific link, group, or your entire account.
Use it to measure campaign performance, identify peak engagement hours, and understand user activity patterns.
This API is available on the Personal plan and above.
/api/statistics/v3/clicks-by-hour?startYmd={startYmd}&endYmd={endYmd}
GET /api/statistics/v2/clicks-by-date
?startYmd=2025-04-01
&endYmd=2025-04-30
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 - linkId string
-
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. - domain string
- Link domain.
- grpIdx integer
-
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-01",
"hour": 0,
"acesCnt": 24,
"pernCnt": 17
},
{
"ymd": "2025-04-02",
"hour": 1,
"acesCnt": 121,
"pernCnt": 198
},
{
"ymd": "2025-04-03",
"hour": 2,
"acesCnt": 84,
"pernCnt": 68
},
{
"ymd": "2025-04-04",
"hour": 3,
"acesCnt": 21,
"pernCnt": 15
},
{
"ymd": "2025-04-05",
"hour": 4,
"acesCnt": 1950,
"pernCnt": 1621
},
{
"ymd": "2025-04-10",
"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.
When to Use This API
Use this API to identify when clicks peak throughout the day.
It helps optimize campaign timing, schedule ad delivery, and analyze user activity patterns based on time.
You can analyze a single link or aggregated data across a group.
This goes beyond simple reporting and enables time-based behavior analysis.
How to Define the Query Scope
You can define the query scope in three ways.
Provide linkId and domain to retrieve hourly clicks for a specific link.
Provide grpIdx to retrieve aggregated clicks across all links in a group.
If neither is provided, the API returns hourly click data for the entire account.
Key features and analysis metrics
This API provides time-based analytics, not just raw click counts.
Hourly clicks (accsCnt)
- Total clicks for each hour
- Identify peak traffic periods
Unique users (pernCnt)
- Number of unique users per hour
- Analyze the click-to-user ratio
Comparing clicks and users enables detection of duplicate clicks and analysis of user behavior patterns.
Use cases
- Optimize campaign timing: Focus sends on peak hours based on historical click data
- Ad scheduling: Adjust delivery times based on high
accsCntperiods - User behavior analysis: Identify peak acquisition hours using
pernCnt - Group performance analysis: Aggregate hourly performance across a campaign using
grpIdx
Things to consider
startYmdandendYmdare required parameters and must follow theyyyy-MM-ddformat.- The maximum queryable date range depends on your plan. Requests exceeding the limit will return an error.
- If
linkIdcontains special characters or Unicode, applyURL encoding. - Click counts and user counts may not match.