Link shortener
List short link metrics
Returns per-click metrics for short links, including device, location, and campaign attribution, within the requested date range.
get/v1/short-links/metrics
Query parameters
fromstring date required
Example:2023-05-01
Start of the date range to query, in YYYY-MM-DD format. Inclusive.
tostring date required
Example:2023-05-31
End of the date range to query, in YYYY-MM-DD format. Inclusive.
phonestring
Example:1872025555
Filters metrics by the phone number associated with the click, in E.164 format.
utm_campaignstring
Example:summer
Filters metrics by utm_campaign name.
pageinteger
Example:1
Page number to retrieve. Default 1.
per_pageinteger
Example:25
Number of records to return per page. Default 25.
Response
Returns a paginated list of short link metrics.
Example response
{
"metrics": [
{
"latitude": 59.3247,
"longitude": 18.056,
"operating_system": "Mac OS X 10.15",
"browser": "Firefox",
"language": "English",
"phone": "12762025555",
"utm_campaign": "summer",
"created_at": "2023-07-19 18:23:42.120Z",
"link_hash": "hd82Jhs21",
"user_id": 100017
}
],
"pagination": {
"current_page": 2,
"per_page": 25,
"total": 101,
"total_pages": 5
}
}