US English (US)
BS Bosnian

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Book a Demo
  • Product Updates
  • Contact Us
English (US)
US English (US)
BS Bosnian
  • Home
  • API V2

How to track Article Analytics through API (views and readings)

Written by Diego Selzlein

Updated at May 25th, 2020, by Diego Selzlein

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Getting Started
    Users Accessibility New to Helpjuice? Start Here Content Management Multiple Languages/Translations & Localization Multilingual Knowledge Bases Analytics Video Tutorials
  • Customization
    Customization Guides
  • API V2
  • API V3 and Webhooks
  • Article Editor
  • Billing / Subscription
  • Authentication
  • Pricing
  • Swifty AI Chatbot
  • Swifty AI Helpbar
  • What's New
+ More

This article is dedicated to knowledge bases that are not managed by Helpjuice itself, but rather use our APIs to retrieve content.

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.

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.

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • How To Perform Searches Through API
  • AHow to Get the API Key
  • How To Authenticate API Requests
  • How To Upvote/Downvote Questions Through API

Copyright © 2025 - Helpjuice

Helpjuice, Inc. is a registered US Corporation, EIN # 45-2275731

Download W9
  • Help
  • Features
  • Pricing
  • About
  • Careers
  • Customers
  • Blog
  • Case Studies
  • Resources
  • Knowledge Base Examples
  • Privacy Policy
  • Terms of Service

Why is the knowledge base important?

With a knowledge base, you can allow your customers to self-help themselves, thus reducing your customer support by up to 60%. Furthermore, you can also have your team get instant answers to the questions they need without having to email themselves all using knowledge base software.

What is the purpose of a knowledge base?

The purpose of knowledge base software is to allow you to host your knowledge base/corporate wiki in one centralized 'hub'. Both your customers, and employees can now access information within seconds!

Made with from Miami, Bosnia, Morocco & Brasil

+1 (833) 387 3877 support@helpjuice.com
Expand