Hits (V1)

API reference for link analytics. The following methods are for hits (visits) that your links have.

get
List Hits by Date Range
https://api.returnam.com/v1/hits/date-range
Lists all link hits in the specified time frame. If no time frame is specified, the default is the last 7 days.

This endpoint provides more details about link hits, such as the exact date and hour, city, region, country, device, operating system and browser.
Request
Response
Request
Headers
x-rtrn-key
required
string
API Key
x-rtrn-secret
required
string
API Secret
Query Parameters
end_date
optional
string
End date of the time frame in UTC. End date can't be more than 60 days apart from Start Date. 
Recommended format: YYYY-MM-DD HH:MM
start_date
optional
string
Start date of the time frame in UTC. 
Recommended format: YYYY-MM-DD HH:MM
slug
optional
string
Get results only for the specified slug.
order
optional
string
The order of the results. 'asc' or 'desc'.
Response
200: OK
Returns an array listing every hit (visit) for the specified query in the request.
[
    {
        "key": "hit_k9bkvocx016m01qwa0yh41ri",
        "slug": "slug-example",
        "domain": "rtrn.am",
        "access_date": "2020-04-22T16:55:21.000Z",
        "city_name": "Los Angeles",
        "region_name": "California",
        "country_code": "US",
        "browser_name": "Chrome",
        "os_name": "Mac OS X",
        "os_version": "10.15.0",
        "device_type": "desktop",
        "device_name": null
    },
    {
        "key": "hit_k96np10f013i01qw46ipg224",
        "slug": "slug-example",
        "domain": "rtrn.am",
        "access_date": "2020-04-19T06:15:18.000Z",
        "city_name": "Mountain View",
        "region_name": "California",
        "country_code": "US",
        "browser_name": "Googlebot",
        "os_name": "Android",
        "os_version": "6.0.1",
        "device_type": "bot",
        "device_name": "Nexus 5"
    }
]
​

API Reference - Previous

Analytics (V1)

Last updated 9 months ago

Hits (V1)

getList Hits by Date Range

get
List Hits by Date Range