Skip to main content

Get Activity Report

This endpoint returns community activity statistics for a specified date range.

The report aggregates active users, category feed visits, content creation, comments, and reactions.

info

This endpoint requires authentication and is available only to users with permission to view console statistics.

HTTP Request

GET /api/v2/reports/activity/

Parameters

NameInTypeRequiredDescription
date_fromquerystring(date)trueStart date (YYYY-MM-DD)
date_toquerystring(date)trueEnd date (YYYY-MM-DD)

Notes

  • date_from and date_to are inclusive.
  • Active users are calculated from daily community visits.
  • Category feed visits are calculated from users that requested a category feed.
  • Category feed users are counted once per user, category and day.
  • visits counts the total number of category feed requests recorded for the same user/category/day.
  • Content statistics are calculated over the selected date range.
  • Hidden system users are excluded from active user and category feed visit statistics.

Metrics Definition

MetricDescription
Active usersUsers that visited the community during the selected period
Daily active usersNumber of active users grouped by day
Category feed visitsUsers that requested a category feed at least once during the day
PostsDiscussions/threads created during the selected period
CommentsComments created during the selected period
ReactionsReactions/votes created during the selected period

Example Request

curl -X GET "/api/v2/reports/activity/?date_from=2026-05-01&date_to=2026-05-31" \
-H "Authorization: Bearer <TOKEN>" \
-H "Accept: application/json"

Responses

StatusMeaningDescription
200OKSuccessful response
400Bad RequestInvalid or missing parameters
401UnauthorizedAuthentication required
403ForbiddenUser cannot access reports

Response Schema

NameTypeDescription
date_fromstring(date)Report start date
date_tostring(date)Report end date
daily_active_usersarrayDaily active users
active_users_totalintegerNumber of unique active users in the date range
daily_category_feed_visitsarrayDaily category feed visits
contentobjectGlobal content statistics
content_by_categoryarrayContent statistics grouped by category

Daily Active Users Object

NameTypeDescription
datestring(date)Activity date
usersintegerNumber of active users

Daily Category Feed Visits Object

NameTypeDescription
datestring(date)Activity date
category_idintegerCategory identifier
category_namestringCategory name
usersintegerUnique users who visited the category
visitsintegerTotal category feed visits recorded

Content Object

NameTypeDescription
postsintegerTotal posts created
commentsintegerTotal comments created
reactionsintegerTotal reactions created

Content By Category Object

NameTypeDescription
category_idintegerCategory identifier
category_namestringCategory name
postsintegerPosts created in the category
commentsintegerComments created in the category
reactionsintegerReactions generated in the category

Example Response

{
"date_from": "2026-05-01",
"date_to": "2026-05-31",
"daily_active_users": [
{
"date": "2026-05-01",
"users": 45
},
{
"date": "2026-05-02",
"users": 51
}
],
"active_users_total": 182,
"daily_category_feed_visits": [
{
"date": "2026-05-01",
"category_id": 3,
"category_name": "Technology",
"users": 20,
"visits": 42
},
{
"date": "2026-05-01",
"category_id": 7,
"category_name": "Events",
"users": 12,
"visits": 18
}
],
"content": {
"posts": 85,
"comments": 423,
"reactions": 1732
},
"content_by_category": [
{
"category_id": 3,
"category_name": "Technology",
"posts": 24,
"comments": 115,
"reactions": 532
},
{
"category_id": 7,
"category_name": "Events",
"posts": 12,
"comments": 48,
"reactions": 201
}
]
}

Example Use Cases

Monthly community activity

GET /api/v2/reports/activity/?date_from=2026-05-01&date_to=2026-05-31

Weekly activity report

GET /api/v2/reports/activity/?date_from=2026-06-01&date_to=2026-06-07

Quarterly engagement analysis

GET /api/v2/reports/activity/?date_from=2026-01-01&date_to=2026-03-31

Category feed engagement analysis

GET /api/v2/reports/activity/?date_from=2026-06-01&date_to=2026-06-30