REreadme
Page Views

Get views by path

Changed on

For a given page, see which viewers and how many times they visited, ordered by count.

get/v2/pageview/{path}

Request

  • Base URL
    https://metrics.readme.io
  • URL
    https://metrics.readme.io/v2/pageview/{path}
  • Auth
    HTTP basic

Path parameters

pathstring required

Query parameters

rangeLengthnumber

Length of the date range.

resolution'hour' | 'day' | 'week' | 'month'

Relative time interval of data buckets.

rangeStartstring date

Starting date

Example:2021-01-01
rangeEndstring date

Ending date

Example:2021-01-01
limitnumber

Deprecated in favor of pageSize. Paginated endpoints ignore this parameter, and endpoints that still honor it treat values above 100 as 100.

pagenumber

Zero-indexed page of results to return.

pageSizenumber

Number of results per page, capped at 100. To retrieve every result, keep incrementing page until the list of results in the response is empty. /v2/pageview/{path} and /v2/thumb/{path} respond with a 404 instead of an empty list once page is past the last page.

Response

Page views broken down by user.

breakdownobject

Changes

  • 4e37e64df55aRevision changes
    • info

      query request parameter limit was deprecated

    • info

      added the non-success response with the status

  • a5cca1b07a6dRevision changes
    • breaking

      the response property /// became nullable for the status