How to track Views and Readings through API
Monitor engagement on questions and categories programmatically
Helpjuice does not have dedicated API endpoints for incrementing views and readings under the "/api" section. However, if you are using our API to show content outside of Helpjuice you can user the same endpoints that we use to keep tracking analytics.
In this article, you’ll learn:
- Which API endpoints track views, readings, and time spent
- How to provide required parameters for analytics
- Best practices to accurately measure engagement
Endpoints
The endpoints are:
Endpoint | Description |
---|---|
POST /questions/question_ID/analytics/DATE/views |
Increment question views for the given date |
POST /questions/question_ID/analytics/DATE/readings |
Increment question readings for the given date |
POST /questions/question_ID/analytics/date/seconds_spent?t=seconds-past | Increment time spent in a question |
POST /categories/category_ID/analytics/date/views |
Increment category views for the given date |
Parameters
Parameter | Type | Description |
---|---|---|
question_id |
Integer | The ID of the question/article for which you want to track analytics |
date | Date (YYYY-MM-DD) | The date on which analytics will be affected. This needs to be from yesterday to tomorrow. Helpjuice does not accept dates far in the past or the future. When an invalid date is provided, we'll use Today. |
seconds-past | Integer | The amount of seconds you want to increase the Time Spent metric by. The limit is 120s and we recommend stop tracking this metric after the user stayed for over a few minutes in the page. Someone might have forgotten it open and left, if you keep tracking the numbers will be very high. |
category_ID | Integer | The ID of the category you want to track analytics for. Categories can only track views. |
Viewing Analytics
- Go to your Analytics section
- Navigate to the Articles or Categories section.
- Export data as needed for reporting purposes.

Best Practices
- Monitor analytics directly through the Helpjuice dashboard.
- Avoid trying to manually increment metrics via unsupported endpoints.
- Regularly review popular articles to identify content gaps.