Skip to contents

List all available KoboToolbox API assets

Source: R/kobo_asset.R
kobo_asset_list.Rd

List all available KoboToolbox API assets and their metadata.

Usage

kobo_asset_list(limit = 100L, minimal = FALSE)

Arguments

limit

integer, the maximum number of assets to return. Default to 100.

minimal

logical, whether to return only the asset uid, name and deployment status. The minimal listing is much faster on accounts with many assets. Default to FALSE.

Value

A data.frame containing the list of all your KoboToolbox API assets and the following metadata:

  • uid the asset unique identifier

  • name the name of the asset

  • asset_type the type of asset (block, survey, question, template, or empty)

  • owner_username the user account of the owner of the asset

  • date_created when the asset was created

  • date_modified when the asset was last modified

  • deployed whether or not the asset is currently deployed

  • submissions the number of submissions for the asset (survey)

  • created_by the user account that created the asset. It differs from the owner after a project transfer. It is NA when the server does not report it, which is the case for some older assets and for all assets on servers older than KoboToolbox KPI version 2.026.23.

Assets are sorted by date of last modification, most recent first, so limit keeps the most recently modified assets.

With minimal = TRUE, the data.frame has the columns uid, name and deployment_status (draft, deployed, archived, or - for empty assets). The minimal listing needs KoboToolbox KPI version 2.026.21 or later. On older servers, the same columns are taken from the full listing.

Examples

if (FALSE) { # \dontrun{
kobo_setup()
asset_list <- kobo_asset_list(limit = 10L)
asset_list
kobo_asset_list(minimal = TRUE)
} # }