[Enhancement]: Year in review API endpoint #1740

Closed
opened 2026-04-24 23:56:26 +02:00 by adam · 4 comments
Owner

Originally created by @donkevlar on GitHub (Feb 16, 2024).

Describe the feature/enhancement

I would love to see an endpoint or series of endpoints for the year in review functionality.

Maybe include: Year, User, specific part of the generated year in review.

Originally created by @donkevlar on GitHub (Feb 16, 2024). ### Describe the feature/enhancement I would love to see an endpoint or series of endpoints for the year in review functionality. Maybe include: Year, User, specific part of the generated year in review.
adam added the enhancement label 2026-04-24 23:56:26 +02:00
adam closed this issue 2026-04-24 23:56:27 +02:00
Author
Owner

@advplyr commented on GitHub (Feb 16, 2024):

These exist already they just aren't documented in the api docs yet. The clients are generating the images on their own so the API is just returning the data.
/api/stats/year/:year <-- server stats
/api/me/stats/year/:year <-- current user stats

Is that what you are requesting? Can you be more specific?

@advplyr commented on GitHub (Feb 16, 2024): These exist already they just aren't documented in the api docs yet. The clients are generating the images on their own so the API is just returning the data. `/api/stats/year/:year` <-- server stats `/api/me/stats/year/:year` <-- current user stats Is that what you are requesting? Can you be more specific?
Author
Owner

@donkevlar commented on GitHub (Feb 16, 2024):

Yes, that's pretty much what I was asking about. But to pull the images themselves using the API. Are they stored on the server, or just generated every time the pages load in?

@donkevlar commented on GitHub (Feb 16, 2024): Yes, that's pretty much what I was asking about. But to pull the images themselves using the API. Are they stored on the server, or just generated every time the pages load in?
Author
Owner

@donkevlar commented on GitHub (Feb 16, 2024):

Just to be clear, I'm referring to these:

When looking at the inspector I didn't see any storage paths when these are pulled in and didn't see what the request was either. That's why I was asking.

image

@donkevlar commented on GitHub (Feb 16, 2024): Just to be clear, I'm referring to these: When looking at the inspector I didn't see any storage paths when these are pulled in and didn't see what the request was either. That's why I was asking. ![image](https://github.com/advplyr/audiobookshelf/assets/21166416/6ab6dd97-97da-4f1d-b35d-ba01fde61549)
Author
Owner

@advplyr commented on GitHub (Feb 18, 2024):

Those images are generated client side using HTML canvas. I don't want to add a library to generate images on the server at this time but you can look at how I built this with HTML canvas https://github.com/advplyr/audiobookshelf/blob/master/client/components/stats/YearInReview.vue

@advplyr commented on GitHub (Feb 18, 2024): Those images are generated client side using HTML canvas. I don't want to add a library to generate images on the server at this time but you can look at how I built this with HTML canvas https://github.com/advplyr/audiobookshelf/blob/master/client/components/stats/YearInReview.vue
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#1740