Get Click Analytics

GET https://api-sandbox.slimlinkdev.com/api/v1/analytics/clicks

Get click analytics for external user

Parameters

start_date string<date> query
end_date string<date> query
page integer query
per_page integer query
group_by string required query
link country city os device browser referrer
link_id string[] query
external_id string<uuid> query

Link external Id as filter

short_url string query
country string[] query

Filter by country

city string[] query

Filter by city

device string[] query

Filter by device format (desktop, mobile etc)

long_url string query

Filter by original (long) URL, partial match

collection_id string<uuid> query

Filter by collection UUID

exclude_bots boolean query

Exclude bot clicks (default false)

Responses

200 Successful operation
400 Validation error
401 Unauthorized

Example response · 200

{
    "data": {
        "group_by": "link",
        "items": [
            {
                "name": "",
                "count": 1,
                "unique_count": 1,
                "percentage": 36
            }
        ],
        "period": {
            "start_date": "2024-01-01T00:00:00Z",
            "end_date": "2024-01-01T00:00:00Z"
        },
        "pagination": {
            "page": 0,
            "per_page": 0
        },
        "total_count": 0,
        "total_unique_count": 0
    },
    "error_code": "string",
    "message": "Request successful",
    "meta": {
        "request_id": "00000000-0000-0000-0000-000000000000",
        "timestamp": "2024-01-01T00:00:00Z"
    }
}