Skip to navigation
API ReferenceV3

Get Weekly Active Users

Get weekly active users for each week in the specified time range.

A user is considered active in a given week if they have created at least min_sessions sessions OR at least min_searches searches during that UTC week.

Weeks are defined as Monday 00:00:00 UTC to Sunday 23:59:59 UTC.

Returns a list of weekly active user counts, one entry per week in the range.

Authentication

AuthorizationBearer

Personal API Key (apk_user_) or Service API Key (apk_)

Query parameters

time_beforeintegerRequired
time_afterintegerRequired
org_idslist of strings or nullOptional
min_sessionsintegerOptional>=0Defaults to 1
min_searchesintegerOptional>=0Defaults to 1

Response

Successful Response
active_usersinteger
end_timeinteger
start_timeinteger

Errors

422
Unprocessable Entity Error