Sign in
Server logs (superusers)

Changed on

List user reports

⚠️ Only available to superusers

Filterable fields by string:

Supports partial filtering

  • username
  • first_name
  • last_name
  • email
  • user_uid
  • organization__name
  • organization__role (e.g., admin, member, owner)
  • organization__website
  • extra_details__data__organization_type
  • extra_details__data__<field> (other string fields, e.g., name, sector, country...)

Filterable fields by int:

Supports exact matching and range operators (e.g., gte, lte)

Total NLP Usage

  • service_usage__total_nlp_usage__asr_seconds_all_time
  • service_usage__total_nlp_usage__mt_characters_all_time
  • service_usage__total_nlp_usage__llm_requests_all_time
  • service_usage__total_nlp_usage__asr_seconds_current_period
  • service_usage__total_nlp_usage__mt_characters_current_period
  • service_usage__total_nlp_usage__llm_requests_current_period

Total Storage/Submissions

  • service_usage__total_storage_bytes
  • service_usage__total_submission_count__cumulative
  • service_usage__total_submission_count__current_period

Service Usage Balances

Prefix: service_usage__balances__<metric>__<value>

Metric:

  • submission
  • asr_seconds
  • mt_characters
  • storage_bytes
  • llm_requests

Value:

  • balance_value
  • balance_percent
  • effective_limit

Ex: service_usage__balances__submission__balance_value

Asset Count

  • asset_count
  • active_project_count

Filterable fields by date:

Supports exact matching and range operators (e.g., gte, lte)

  • date_joined
  • last_login
  • last_updated (Represents the last modified timestamp of the materialized view)
  • extra_details__date_removal_requested
  • extra_details__date_removed
  • extra_details_password_date_changed

Filterable fields by boolean:

  • is_superuser
  • is_staff
  • is_active
  • validated_email
  • extra_details__validated_password
  • mfa_is_active
  • sso_is_active
  • accepted_tos
  • extra_details__data__newsletter_subscription
  • service_usage__balances__metric__exceeded (metric: submission, asr_seconds, mt_characters, storage_bytes, llm_requests)
  • account_restricted

Filterable fields by list:

Subscription filtering:

Has subscriptions

?q=subscriptions__0__id__isnull:False

No subscriptions

?q=subscriptions__0__id__isnull:True

Subscription id

?q=subscriptions[]__id:sub_1QwPItAR39rDI89stzLJ040p

Active subscriptions

?q=subscriptions[]__status:active

get/api/v2/user-reports/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

limitinteger

Number of results to return per page. Use with start.

offsetinteger

Deprecated alias of start.

orderingstring

Which field to use when ordering the results.

startinteger

The initial index from which to return the results. Use with limit.

Response

nextstring uri nullable
previousstring uri nullable

Example response

{
  "next": "https://kf.kobotoolbox.org/api-endpoint/?start=400&limit=100",
  "previous": "https://kf.kobotoolbox.org/api-endpoint/?start=200&limit=100"
}

Changes