Server logs (superusers)

List all project history logs for all projects.

⚠️_Only available to superusers_

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

Filterable fields for all project history logs:

  • date_created
  • user_uid
  • user__username
  • user__email
  • user__is_superuser
  • metadata__source
  • metadata__ip_address
  • metadata__asset_uid
  • metadata__log_subtype
    • available subtypes: "project", "permission"
  • action

available actions:

  add-media
  add-submission
  allow-anonymous-submissions
  archive
  clone-permissions
  connect-project
  delete-media
  delete-service
  delete-submission
  deploy
  disable-sharing
  disallow-anonymous-submissions
  disconnect-project
  enable-sharing
  export
  modify-imported-fields
  modify-qa-data
  modify-service
  modify-sharing
  modify-submission
  modify-user-permissions
  redeploy
  register-service
  replace-form
  share-data-publicly
  share-form-publicly
  transfer
  unarchive
  unshare-data-publicly
  unshare-form-publicly
  update-content
  update-name
  update-settings
  update-qa
  view-data

Filterable fields by action:

  • add-media

    a. metadata__asset-file__uid

    b. metadata__asset-file__filename

  • add-submission

    a. metadata__submission__submitted_by

    b. metadata__submission__root_uuid

  • archive

    a. metadata__latest_version_uid

  • clone-permissions

    a. metadata__cloned_from

  • connect-project

    a. metadata__paired-data__source_uid

    b. metadata__paired-data__source_name

  • delete-media

    a. metadata__asset-file__uid

    b. metadata__asset-file__filename

  • delete-service

    a. metadata__hook__uid

    b. metadata__hook__endpoint

    c. metadata__hook__active

  • delete-submission

    a. metadata__submission__submitted_by

    b. metadata__submission__root_uuid

  • deploy

    a. metadata__latest_version_uid

    b. metadata__latest_deployed_version_uid

  • disconnect-project

    a. metadata__paired-data__source_uid

    b. metadata__paired-data__source_name

  • modify-imported-fields

    a. metadata__paired-data__source_uid

    b. metadata__paired-data__source_name

  • modify-qa-data

    a. metadata__submission__submitted_by

    b. metadata__submission__root_uuid

  • modify-service

    a. metadata__hook__uid

    b. metadata__hook__endpoint

    c. metadata__hook__active

  • modify-submission

    a. metadata__submission__submitted_by

    b. metadata__submission__root_uuid

    b. metadata__submission__status (only present if changed)

  • modify-user-permissions

    a. metadata__permissions__username

  • redeploy

    a. metadata__latest_version_uid

    b. metadata__latest_deployed_version_uid

  • register-service

    a. metadata__hook__uid

    b. metadata__hook__endpoint

    c. metadata__hook__active

  • transfer

    a. metadata__username

  • unarchive

    a. metadata__latest_version_uid

  • update-name

    a. metadata__name__old

    b. metadata__name__new

  • update-settings

    a. metadata__settings__description__old

    b. metadata__settings__description__new

This endpoint can be paginated with 'start' and 'limit' parameters

get/api/v2/project-history-logs/

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

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",
  "results": [
    {
      "user": "https://kf.kobotoolbox.org/api/v2/users/bob/"
    }
  ]
}

Changes

    • info

      added the optional property /// to the response with the status