Behavior model

Table of contents

  1. Introduction
  2. Fields
  3. How it fits together
  4. Example
  5. Permissions
  6. API access

Introduction

A behavior is the behavioral side of a session: what the subjects were doing while the session was recorded. It is one of the parts that describe a session, next to data acquisitions (what was recorded), manipulations (what was delivered) and epochs (when). Behaviors are recorded in subject-based sessions only.

Each behavior records one behavioral assay actually performed, with particular subjects, on a particular rig. It links the standardized task description (via the assay) with the physical apparatus (via the setup). A behavior has no type of its own; the assay supplies that, and the behavior stores no task parameters.

A session and its parts: the behavior (what the subjects were doing), data acquisitions (what was recorded) and manipulations (what was delivered), each placed in an epoch of the session (when); behaviors run an assay on a setup, and acquisitions and manipulations pass through experimental interfaces. A session and its parts. The behavior, drawn solid, says what the subjects were doing; data acquisitions and manipulations say what was recorded and delivered, and epochs say when. A behavior runs a behavioral assay on a setup; how those two are defined is shown under How it fits together.

This model with its direct connections only: drag to pan, Ctrl + scroll to zoom, click a model to select it, use the chevron to see its fields.

Fields

FieldDescription
SessionSession of the behavior (required). Must reference an existing session.
SubjectsEvery subject that took part (required). The choices come from the session’s own subjects, so add a subject to the session first if it is missing here. Select all participants rather than creating one behavior per animal.
SetupThe physical rig the behavior ran on (required). Must reference an existing setup where you are at least a Contributor.
Behavioral assayThe lab method performed (required). Must reference an existing behavioral assay where you are at least a Contributor.
OrderWhere this behavior appears among the session’s behaviors. Does not imply a start time.
NotesWhat was specific to this occurrence: deviations, technical problems, notable outcomes (string; maximum length: 500 characters). Anything that repeats every run belongs on the assay.

Behaviors can be linked to epochs of the session.

How it fits together

The behavioral track and the setup track: behavioral categories group paradigms, and an assay is your lab's version of a paradigm on a setup type; a setup is your rig of a setup type, with its equipment. A behavior in a session runs one assay on one setup with its subjects. The behavioral track (left) and the setup track (right) run from the shared taxonomies through your lab’s personal attributes and meet in a behavior recorded in a session. This page describes the behavior, drawn solid. The setup type category is a field of the setup type, not a separate record.

A behavior is the junction point of two independent hierarchies, and both must be defined before you can record a behavior.

A behavior (this page) combines a behavioral assay with a specific physical setup and the subjects involved, within a session. The setup type of the chosen setup is shown beside the field so you can check the rig suits the assay.

The assay and the setup are personal attributes reached through their groups, while the behavior belongs to the session’s projects. You need to be at least a Contributor on both the assay and the setup to record a behavior with them.

Example

LevelExample
Behavioral assayEPM 5-min test
SetupEPM rig B, Room 108
SubjectsMouse 01, Mouse 02
BehaviorSession 2026-06-01: Elevated Plus Exploration, trial 1

Permissions

Behaviors inherit permissions through the projects of their associated session. The subject, setup and assay selectors are separately restricted to entries you may use.

Visit the permissions page to learn more.

API access

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