SHshort
link

Top column values for specified link path

Returns values and counts for specified link path

post/link/{linkId}/top

Request

  • Base URL
    https://statistics.short.io/statistics
  • URL
    https://statistics.short.io/statistics/link/{linkId}/top
  • Auth
    API key in header Authorization

Path parameters

linkIdstring required

Link identifier

Request body

period'custom' | 'today' | 'yesterday' | 'total' | 'week' | 'month' | 'lastmonth' | 'last7' | 'last30'

One of predefined time intervals. Select custom to provide custom dates

column'path' | 'path_404' | 'method' | 'st' | 'proto' | 'human' | 'browser' | 'browser_version' | 'country' | 'city' | 'social' | 'refhost' | 'os' | 'utm_source' | 'utm_medium' | 'utm_campaign' | 'goal_completed' | 'ab_path' required

column for the aggregation

startDatestring date

Returns statistics for clicks after given date. Required if period is custom

endDatestring date

Returns statistics for clicks before given date. Required if period is custom

limitnumber
tzstring

Timezone name

prefixstring

Response

top link path response

scorenumber required

Number of clicks

columnstring required

Value of the column

displayNamestring required

Display name of the column

Example response

[
  {
    "score": 1234,
    "column": "Chrome",
    "displayName": "United States"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.