SHshort
domain

Domain statistics

Returns detailed statistics for domain in given period

post/domain/{domainId}

Request

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

Path parameters

domainIdinteger required

Domain identifier

Request body

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

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

skipTopsboolean

Skip top records

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

One of predefined time intervals

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

Response

domain statistics

clicksnumber required

Total clicks number in interval

humanClicksnumber required

Human clicks number in interval

linksnumber required

Number of links, created in interval

linksChangestring

Difference between old number of links in previous and current period

linksChangePositiveboolean

true if in current period there were more links created

clicksPerLinkstring

Average number of clicks per link

clicksPerLinkChangestring

Change of average number of clicks per link compared to previous period

humanClicksPerLinkstring

Average number of clicks per link, done by humans

prevClicksChangestring

Difference between old number of clicks in previous and current period

humanClicksChangestring

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

humanClicksChangePositiveboolean

true if in current period there were more clicks done

Example response

{
  "clicks": 12345,
  "humanClicks": 10000,
  "links": 100,
  "linksChange": "12.34",
  "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"
  },
  "clicksPerLink": "0.12",
  "clicksPerLinkChange": "234.56",
  "humanClicksPerLink": "0.06",
  "prevClicksChange": "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.