@modelhealth/modelhealth
    Preparing search index...

    Interface ActivityListOptions

    Named filters for ActivitiesResource.list.

    All fields are optional — omit any to leave that filter unconstrained.

    interface ActivityListOptions {
        activityType?: number | ActivityTypeInfo;
        calibrationSession?: string | Session;
        createdAfter?: string | Date;
        createdBefore?: string | Date;
        createdBy?: number[];
        excludeAnalysisError?: boolean;
        excludeCalibration?: boolean;
        limit?: number;
        onlyCompleted?: boolean;
        orderBy?: ActivityOrderBy;
        search?: string;
        subject?: number | Subject;
        tags?: string[];
    }
    Index
    activityType? calibrationSession? createdAfter? createdBefore? createdBy? excludeAnalysisError? excludeCalibration? limit? onlyCompleted? orderBy? search? subject? tags?
    activityType?: number | ActivityTypeInfo

    Only activities of this type. Accepts a type from ModelHealthClient.activityTypes or its id.

    calibrationSession?: string | Session

    Only activities recorded under this calibration session. Accepts a Session or its id.

    createdAfter?: string | Date

    Only activities created on or after this date (inclusive). A Date counts as the day it falls on in the local time zone, not in UTC. A string must read YYYY-MM-DD.

    createdBefore?: string | Date

    Only activities created on or before this date (inclusive). A Date counts as the day it falls on in the local time zone, not in UTC. A string must read YYYY-MM-DD.

    createdBy?: number[]

    Only activities belonging to one of these accounts, by numeric account id.

    excludeAnalysisError?: boolean

    Excludes activities whose analysis failed.

    excludeCalibration?: boolean

    Excludes calibration and neutral-pose activities. Default true.

    limit?: number

    Caps the total number of activities the stream yields across the whole iteration. Omit to iterate every match.

    onlyCompleted?: boolean

    Only activities whose analysis has finished.

    orderBy?: ActivityOrderBy

    Field to sort by. Defaults to "-createdAt".

    search?: string

    Free-text search against the activity's name.

    subject?: number | Subject

    Only activities belonging to this subject. Accepts a Subject or its id.

    tags?: string[]

    Only activities carrying every tag in this list.

    Settings
    Member Visibility

    On This Page
    Properties