Link Search Menu Expand Document

Collection model

Table of contents

  1. Introduction
  2. Fields
  3. Permissions
  4. Collection API access

Introduction

Collections allow for creating subgroups of sessions within a project. They can be used to define a set of sessions for a specific analysis or figure. All sessions in a collection must belong to the same project.

Fields

FieldDescription
NameName of the collection (required; string; max length: 100 characters; must be unique within the project)
ProjectThe project the collection belongs to (required)
SessionsSessions in the collection. All sessions must belong to the same project (required)
DescriptionA text description of the collection, providing additional context and information. Pictures can be uploaded and inserted.
TagsTags for the collection. Great for organizational purposes, quick labeling, and filtering.

Permissions

Collections inherit permissions from their associated project. You can only add sessions to the collection that are part of the same project.

Visit the permissions page to learn more.

Collection API access

The API allows for programmable access to collections. Learn more about the collections’ fields and data structure on the Collection API page.