Skip to main content

Get Statistics

The stats endpoint allows you to retrieve analytics data about clicks.

Endpoint​

GET /api/stats

Query Parameters​

ParameterTypeDescription
startDatestringStart date for the stats (format: YYYY-MM-DD)
endDatestringEnd date for the stats (format: YYYY-MM-DD)
itemTypestringOptional filter by item type
userIdstringOptional filter by user ID

Example Request​

GET /api/stats?startDate=2023-01-01&endDate=2023-01-31&itemType=menu

Response​

Success Response​

{
"success": true,
"data": {
"totalClicks": 1250,
"uniqueUsers": 320,
"clicksByItem": [
{
"itemId": "portfolio-link",
"count": 450
},
{
"itemId": "contact-link",
"count": 320
}
],
"clicksByDay": [
{
"date": "2023-01-01",
"count": 42
},
{
"date": "2023-01-02",
"count": 38
}
]
}
}

Error Response​

{
"success": false,
"error": "Invalid date format"
}