Logging

List all access logs for the authenticated user

Submissions will be grouped together by hour

Results from this endpoint can be filtered by a boolean query specified in the q parameter.

Filterable fields:

  • date_created
  • metadata__source
  • metadata__auth_type
  • metadata__ip_address

Some examples:

  • All logs from a specific IP address api/v2/access-logs/?q=metadata__ip_address:"127.0.0.1"
  • All logs created after Jan, 1 2025 api/v2/access-logs/?q=date_created__date__gte:"2025-01-01"

Notes: Do not forget to wrap search terms in double-quotes if they contain spaces (e.g. date and time "2022-11-15 20:34")

get/api/v2/access-logs/me/

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.

qstring
startinteger

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

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "https://kf.kobotoolbox.org/api-endpoint/?start=400&limit=100",
  "previous": "https://kf.kobotoolbox.org/api-endpoint/?start=200&limit=100",
  "results": [
    {
      "user": "https://kf.kobotoolbox.org/api/v2/users/bob/"
    }
  ]
}

Changes