Module dataset_api

Enums

ClearDatasetError

struct for typed errors of method clear_dataset

CreateDatasetError

struct for typed errors of method create_dataset

DeleteDatasetByTrackingIdError

struct for typed errors of method delete_dataset_by_tracking_id

DeleteDatasetError

struct for typed errors of method delete_dataset

GetAllTagsError

struct for typed errors of method get_all_tags

GetDatasetError

struct for typed errors of method get_dataset

GetDatasetsFromOrganizationError

struct for typed errors of method get_datasets_from_organization

GetUsageByDatasetIdError

struct for typed errors of method get_usage_by_dataset_id

UpdateDatasetError

struct for typed errors of method update_dataset

Functions

clear_dataset

Removes all chunks, files, and groups from the dataset while retaining the analytics and dataset itself. The auth’ed user must be an owner of the organization to clear a dataset.

create_dataset

Auth’ed user must be an owner of the organization to create a dataset.

delete_dataset

Auth’ed user must be an owner of the organization to delete a dataset.

delete_dataset_by_tracking_id

Auth’ed user must be an owner of the organization to delete a dataset.

get_all_tags

Scroll through all tags in the dataset and get the number of chunks in the dataset with that tag plus the total number of unique tags for the whole datset.

get_dataset

Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

get_datasets_from_organization

Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

get_usage_by_dataset_id

Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

update_dataset

One of id or tracking_id must be provided. The auth’ed user must be an owner of the organization to update a dataset.