Skip to main content
GET
/
reporting
/
knowledge
/
articles
Retrieve articles statistics for the Knowledge Base
curl --request GET \
  --url https://api.getfernand.com/reporting/knowledge/articles \
  --header 'X-API-Key: <api-key>'
[
  {
    "id": 789,
    "title": "How to reset your password",
    "link": "https://help.piedpiper.com/articles/789-how-to-reset-your-password",
    "category_id": 12,
    "last_updated": "2026-01-15T14:30:00Z",
    "views": 1847,
    "score": {
      "disappointed": 5,
      "neutral": 12,
      "happy": 48
    }
  }
]
Returns the top 20 articles for the specified date range. Results can be ordered by various metrics to identify high-performing or problematic articles.

Authorizations

​
X-API-Key
string
header
required

Authenticate your account by including your secret key in API requests. You can manage your API keys in the Dashboard.

Authentication to the API is performed by using the HTTP Header X-API-Key.

Query Parameters

​
start
string<date>
required

Start date for the statistics range in YYYY-MM-DD format.

​
end
string<date>
required

End date for the statistics range in YYYY-MM-DD format.

​
order_by
enum<string>
default:total_views

Field to order results by.

Available options:
last_updated,
total_views,
disappointed,
neutral,
happy
​
order_way
enum<string>
default:DESC

Sort direction (ascending or descending).

Available options:
ASC,
DESC

Response

Articles retrieved successfully.

​
id
integer

Unique identifier of the article.

Example:

789

​
title
string

Title of the article.

Example:

"How to reset your password"

​
link
string<uri>

Full URL to view the article.

Example:

"https://help.piedpiper.com/articles/789-how-to-reset-your-password"

​
category_id
integer | null

ID of the collection/category this article belongs to.

Example:

12

​
last_updated
string<date-time>

ISO 8601 timestamp of when the article was last updated.

Example:

"2026-01-15T14:30:00Z"

​
views
integer

Total number of views during the specified date range.

Example:

1847

​
score
object

Breakdown of user satisfaction ratings for this article.