get/tpvsr_2/stat
Method description
This method allows to pull visits stats of a short link: browsers, platforms, sources (e.g., websites/social media), locations, and clicks, including unique clicks.
Method parameters
Parameter | Type | Description | Default |
Required | |||
---|---|---|---|
hash | string | Short link hash |
Returned data
Parameter | Type | Description |
result (object) | ||
---|---|---|
countries | object | Report by country |
referrers | object(overall, sites, social, undefined) |
Report by source There are 3 types of sources: websites, social media, other sources. |
counts_unique | int | Unique clicks count |
browsers | set |
Browsers Possible values:
|
oses | set |
Platform/operating system (OS) Possible values:
|
result.countries[N] | ||
count | int | Click count |
country_code | string | Country code |
name | string | Country name |
result.referrers | ||
overall | object | A report on the total number of clicks from all sources |
sites | object | A report on the total number of clicks from websites |
social | object | A report on the total number of clicks from social media |
undefined | object | A report on the total number of clicks from other media |
result.referrers.[overall|sites|social|undefined] | ||
count | int | A total number of clicks from a selected source |
refs | object | A report for every sources website |
result.referrers.[overall|sites|social|undefined].refs[N] | ||
count | int | A number of clicks from a selected website, social media, other source |
referer | string | Click source (domain, social media, etc.) |
referer_index | string | Source index or a link to a source if it is undefined |
items | object | Report by the source segments |
result.referrers.[overall|sites|social|undefined].refs[N].items[N] | ||
count | int | A number of clicks from a selected page of a website, social media, other source |
referer | string | A link to the selected page of a website, social media, other source |