link

Link statistics

Returns detailed statistics for link in given period

get/link/{linkId}

Request

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

Path parameters

linkIdstring required

Query parameters

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

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

tzstring

Timezone name

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

skipTopsboolean

Skip top records

clicksChartInterval'hour' | 'day' | 'week' | 'month'

One of predefined time intervals

Response

link statistics

totalClicksnumber required

Total clicks number in interval

humanClicksnumber required

Human clicks number in interval

totalClicksChangestring

Difference between old number of clicks in previous and current period

humanClicksChangestring

Difference between old number of human clicks in previous and current period

Example response

{
  "totalClicks": 12345,
  "humanClicks": 10000,
  "interval": {
    "startDate": "2019-09-11T02:59:59.999Z",
    "endDate": "2019-08-11T02:59:59.000Z",
    "prevStartDate": "2019-07-11T03:00:00.000Z",
    "prevEndDate": "2019-08-11T03:00:00.000Z"
  },
  "totalClicksChange": "34.53",
  "humanClicksChange": "-67.15",
  "clickStatistics": {
    "datasets": [
      {
        "data": [
          {
            "y": 5,
            "x": "2019-08-11T03:00:00.000Z"
          }
        ]
      }
    ]
  },
  "referer": [
    {
      "score": 123,
      "referer": "google.com"
    }
  ],
  "social": [
    {
      "score": 123,
      "social": "Facebook"
    }
  ],
  "browser": [
    {
      "score": 54,
      "browser": "Firefox"
    }
  ],
  "country": [
    {
      "score": 54,
      "country": "US",
      "countryName": "United States"
    }
  ],
  "city": [
    {
      "city": "5393015",
      "name": "Santa Clara",
      "countryCode": "US"
    }
  ],
  "os": [
    {
      "score": 13,
      "os": "Windows"
    }
  ]
}

Changes

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