REreadme
Page Quality

Get average page quality

Get the total number of project page quality votes, broken down into positive and overall votes.

get/v2/thumb/average

Request

  • Base URL
    https://metrics.readme.io
  • URL
    https://metrics.readme.io/v2/thumb/average
  • Auth
    HTTP basic

Query parameters

string
OR
string[]
Example:/docs/getting-started

Project documentation or normalized API URL path.

string
OR
Email[]

Authenticated user's email.

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

Response

Total and postitive votes per month for the last 6 months.

periodstring date-time
totalnumber
positivenumber

Changes

No recorded changes to this operation across all 4 revisions of this API.