buzz.bookhive.getReadingStats

bookhive.buzz

Documentation

Get reading statistics for a user for a given year.

main query

Get reading statistics for a user for a given year.

Parameters

handle string Required

The user handle or DID

year integer Optional

The year to fetch stats for. Defaults to current year.

Output

Encodingapplication/json
availableYears array Required

No description available.

year integer Required

No description available.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
The user handle or DID
The year to fetch stats for. Defaults to current year.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "stats",
        "availableYears",
        "year"
      ],
      "properties": {
        "year": {
          "type": "integer"
        },
        "stats": {
          "ref": "buzz.bookhive.getReadingStats#readingStats",
          "type": "ref"
        },
        "availableYears": {
          "type": "array",
          "items": {
            "type": "integer"
          }
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "handle"
    ],
    "properties": {
      "year": {
        "type": "integer",
        "maximum": 2100,
        "minimum": 2000,
        "description": "The year to fetch stats for. Defaults to current year."
      },
      "handle": {
        "type": "string",
        "description": "The user handle or DID"
      }
    }
  },
  "description": "Get reading statistics for a user for a given year."
}
bookSummary object

No description available.

Properties

authors string Required

No description available.

cover string Optional

No description available.

hiveId string Required

No description available.

pageCount integer Optional

No description available.

rating integer Optional

No description available.

thumbnail string Optional

No description available.

title string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "hiveId",
    "title",
    "authors"
  ],
  "properties": {
    "cover": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "hiveId": {
      "type": "string"
    },
    "rating": {
      "type": "integer"
    },
    "authors": {
      "type": "string"
    },
    "pageCount": {
      "type": "integer"
    },
    "thumbnail": {
      "type": "string"
    }
  }
}
genreStat object

No description available.

Properties

count integer Required

No description available.

minimum: 0
genre string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "genre",
    "count"
  ],
  "properties": {
    "count": {
      "type": "integer",
      "minimum": 0
    },
    "genre": {
      "type": "string"
    }
  }
}
ratingDistribution object

No description available.

Properties

five integer Required

No description available.

minimum: 0
four integer Required

No description available.

minimum: 0
one integer Required

No description available.

minimum: 0
three integer Required

No description available.

minimum: 0
two integer Required

No description available.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "one",
    "two",
    "three",
    "four",
    "five"
  ],
  "properties": {
    "one": {
      "type": "integer",
      "minimum": 0
    },
    "two": {
      "type": "integer",
      "minimum": 0
    },
    "five": {
      "type": "integer",
      "minimum": 0
    },
    "four": {
      "type": "integer",
      "minimum": 0
    },
    "three": {
      "type": "integer",
      "minimum": 0
    }
  }
}
readingStats object

No description available.

Properties

averagePageCount integer Optional

No description available.

averageRating integer Optional

Average rating * 10 (e.g. 42 = 4.2 stars)

booksCount integer Required

No description available.

minimum: 0
pagesRead integer Optional

No description available.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "booksCount",
    "ratingDistribution",
    "topGenres"
  ],
  "properties": {
    "pagesRead": {
      "type": "integer",
      "minimum": 0
    },
    "topGenres": {
      "type": "array",
      "items": {
        "ref": "buzz.bookhive.getReadingStats#genreStat",
        "type": "ref"
      }
    },
    "booksCount": {
      "type": "integer",
      "minimum": 0
    },
    "longestBook": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "shortestBook": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "averageRating": {
      "type": "integer",
      "description": "Average rating * 10 (e.g. 42 = 4.2 stars)"
    },
    "lastBookOfYear": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "firstBookOfYear": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "mostPopularBook": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "averagePageCount": {
      "type": "integer"
    },
    "leastPopularBook": {
      "ref": "buzz.bookhive.getReadingStats#bookSummary",
      "type": "ref"
    },
    "ratingDistribution": {
      "ref": "buzz.bookhive.getReadingStats#ratingDistribution",
      "type": "ref"
    }
  }
}

Lexicon Garden

@