model

Mar 19, 2026

Changes in this version

type CollectionPageItem

+ Validation *ValidationRule

type Instruction

+ Validation *ValidationRule

type PageInstruction

+ Validation *ValidationRule

type UnitOption

+ Validation *ValidationRule

+ type ValidationRule struct

+ Max *float64

+ Min *float64

+ Type string

Mar 11, 2026

Changes in this version

type InstructionOption

+ Exclusive bool

type MultipleChoiceOption

+ Exclusive bool

Feb 26, 2026

Changes in this version

type CollectionPageItem

+ ContentFormat ContentFormat

+ type ContentFormat string

+ const ContentFormatHTML

+ const ContentFormatMarkdown

type PageInstruction

+ ContentFormat ContentFormat

Feb 16, 2026

Changes in this version

+ const DataCollectionMethodAITBCollection

type AITaskBuilderAnswerOption

+ ContentType string

+ Explanation string

+ FileKey string

+ FileName string

+ FileSizeMB float64

+ Unit string

type AITaskBuilderResponseType

+ const AITaskBuilderResponseTypeFileUpload

+ const AITaskBuilderResponseTypeFreeTextWithUnit

+ type BaseEntity struct

+ CreatedAt *time.Time

+ CreatedBy string

+ ID string

+ LastModifiedAt *time.Time

+ LastModifiedBy string

+ SchemaVersion int

+ type Collection struct

+ CreatedAt time.Time

+ CreatedBy string

+ ID string

+ ItemCount int

+ Name string

+ TaskDetails *TaskDetails

+ func (c Collection) Description() string

+ func (c Collection) FilterValue() string

+ func (c Collection) Title() string

+ type CollectionInstruction = CollectionPageItem

+ type CollectionPage struct

+ Order int

+ PageItems []CollectionInstruction

+ type CollectionPageItem struct

+ AcceptedFileTypes []string

+ AltText string

+ AnswerLimit *int

+ Caption string

+ Content string

+ DefaultUnit string

+ Description string

+ DisableDropdown *bool

+ HelperText string

+ MaxFileCount *int

+ MaxFileSizeMB *float64

+ MinFileCount *int

+ Options []InstructionOption

+ Order int

+ PlaceholderTextInput string

+ Type string

+ URL string

+ UnitOptions []UnitOption

+ UnitPosition UnitPosition

+ type CompletionCode struct

+ Actions []map[string]interface{}

+ Code string

+ CodeType string

+ type CreateAITaskBuilderCollection struct

+ CollectionItems []CollectionPage

+ Name string

+ TaskDetails *TaskDetails

+ WorkspaceID string

type CreateStudy

+ AccessDetailsCollectionID string

+ CompletionCodes []CompletionCode

+ DataCollectionID string

+ DataCollectionMetadata map[string]interface{}

+ DataCollectionMethod string

+ StudyLabels []string

type Instruction

+ AcceptedFileTypes []string

+ DefaultUnit string

+ HelperText string

+ MaxFileCount *int

+ MaxFileSizeMB *float64

+ MinFileCount *int

+ PlaceholderTextInput string

+ UnitOptions []UnitOption

+ UnitPosition UnitPosition

+ type InstructionType string

+ const ContentBlockTypeImage

+ const ContentBlockTypeRichText

+ const InstructionTypeFileUpload

+ const InstructionTypeFreeText

+ const InstructionTypeFreeTextWithUnit

+ const InstructionTypeMultipleChoice

+ const InstructionTypeMultipleChoiceWithFreeText

type Message

+ ChannelID string

+ ID string

+ Sender string

+ Type string

+ func (m Message) GetSenderID() string

+ type MessageData struct

+ Category string

+ StudyID string

+ type MultipleChoiceOption struct

+ Heading string

+ Label string

+ Value string

+ type Page struct

+ Order int

+ PageItems []PageInstruction

+ type PageInstruction struct

+ AcceptedFileTypes []string

+ AltText string

+ AnswerLimit int

+ Caption string

+ Content string

+ DefaultUnit string

+ Description string

+ DisableDropdown *bool

+ HelperText string

+ MaxFileCount *int

+ MaxFileSizeMB *float64

+ MinFileCount *int

+ Options []MultipleChoiceOption

+ Order int

+ PlaceholderTextInput string

+ Type InstructionType

+ URL string

+ UnitOptions []UnitOption

+ UnitPosition UnitPosition

+ type UnitOption struct

+ Label string

+ Value string

+ type UnitPosition string

+ const UnitPositionPrefix

+ const UnitPositionSuffix

+ type UpdateCollection struct

+ CollectionItems []Page

+ Description string

+ Name string

+ TaskDetails *TaskDetails

+ WorkspaceID string

Jan 6, 2026

Changes in this version

type CreateStudy

+ CredentialPoolID string

type Dataset

+ CreatedAt string

+ CreatedBy string

+ Name string

+ Status DatasetStatus

+ WorkspaceID string

+ type DatasetStatus string

+ const DatasetStatusError

+ const DatasetStatusProcessing

+ const DatasetStatusReady

+ const DatasetStatusUninitialised

+ type Instruction struct

+ BatchID string

+ CreatedAt string

+ CreatedBy string

+ Description string

+ ID string

+ Options []InstructionOption

+ Type string

+ type InstructionOption struct

+ Heading string

+ Label string

+ Value string

type Study

+ CredentialPoolID string

type UpdateStudy

+ CredentialPoolID string

Oct 27, 2025

Changes in this version

+ const DefaultCurrency

+ const StatusActive

+ const StatusAll

+ const StatusAwaitingReview

+ const StatusCompleted

+ const StatusScheduled

+ const StatusUnpublished

+ const TransitionStudyPause

+ const TransitionStudyPublish

+ const TransitionStudyStart

+ const TransitionStudyStop

+ var StudyListStatus = []string

+ var StudyStatuses = []string

+ var TransitionList = []string

+ type AITaskBuilderAnswerOption struct

+ Value string

+ type AITaskBuilderBatch struct

+ CreatedAt time.Time

+ CreatedBy string

+ Datasets []Dataset

+ ID string

+ Name string

+ SchemaVersion int

+ Status string

+ TaskDetails TaskDetails

+ TasksPerGroup int

+ TotalInstructionCount int

+ TotalTaskCount int

+ WorkspaceID string

+ type AITaskBuilderBatchStatus struct

+ Status AITaskBuilderBatchStatusEnum

+ type AITaskBuilderBatchStatusEnum string

+ const AITaskBuilderBatchStatusError

+ const AITaskBuilderBatchStatusProcessing

+ const AITaskBuilderBatchStatusReady

+ const AITaskBuilderBatchStatusUninitialised

+ type AITaskBuilderResponse struct

+ BatchID string

+ CorrelationID string

+ CreatedAt time.Time

+ ID string

+ Metadata map[string]string

+ ParticipantID string

+ Response AITaskBuilderResponseData

+ SchemaVersion int

+ SubmissionID string

+ TaskID string

+ type AITaskBuilderResponseData struct

+ Answer []AITaskBuilderAnswerOption

+ InstructionID string

+ Text *string

+ Type AITaskBuilderResponseType

+ type AITaskBuilderResponseType string

+ const AITaskBuilderResponseTypeFreeText

+ const AITaskBuilderResponseTypeMultipleChoice

+ const AITaskBuilderResponseTypeMultipleChoiceWithFreeText

+ type Campaign struct

+ ID string

+ Name string

+ SignupLink string

+ type CreateStudy struct

+ CompletionCode string

+ CompletionOption string

+ Description string

+ DeviceCompatibility []string

+ EligibilityRequirements []struct{ ... }

+ EstimatedCompletionTime int

+ ExternalStudyURL string

+ Filters []Filter

+ InternalName string

+ MaximumAllowedTime int

+ Name string

+ PeripheralRequirements []string

+ Project string

+ ProlificIDOption string

+ Reward float64

+ SubmissionsConfig struct{ ... }

+ TotalAvailablePlaces int

+ type Dataset struct

+ ID string

+ TotalDatapointCount int

+ type Filter struct

+ Choices map[string]string

+ DataType string

+ FilterDescription string

+ FilterID string

+ FilterTitle string

+ ID string

+ Max any

+ Min any

+ Question string

+ SelectedRange FilterRange

+ SelectedValues []string

+ Type string

+ func (f Filter) Description() string

+ func (f Filter) FilterValue() string

+ func (f Filter) Title() string

+ type FilterRange struct

+ Lower any

+ Upper any

+ type FilterSet struct

+ EligibleParticipantCount int

+ Filters []Filter

+ ID string

+ IsDeleted bool

+ IsLocked bool

+ Name string

+ OrganisationID string

+ Version int

+ WorkspaceID string

+ type Hook struct

+ EventType string

+ ID string

+ IsEnabled bool

+ TargetURL string

+ WorkspaceID string

+ type HookEvent struct

+ DateCreated time.Time

+ DateUpdated time.Time

+ EventType string

+ ID string

+ ResourceID string

+ Status string

+ TargetURL string

+ type HookEventType struct

+ Description string

+ EventType string

+ type Message struct

+ Body string

+ Data map[string]any

+ DatetimeCreated time.Time

+ SenderID string

+ StudyID string

+ type ParticipantGroup struct

+ ID string

+ Name string

+ ProjectID string

+ type ParticipantGroupMembership struct

+ DatetimeCreated time.Time

+ ParticipantID string

+ type Project struct

+ Description string

+ ID string

+ Owner string

+ Title string

+ Users []User

+ Workspace string

+ type Requirement struct

+ Attributes []RequirementAttribute

+ Category string

+ Cls string

+ DetailsDisplay string

+ ID string

+ Order int

+ Query RequirementQuestion

+ Recommended bool

+ RequirementType string

+ Subcategory any

+ Type string

+ func (r Requirement) Description() string

+ func (r Requirement) FilterValue() string

+ func (r Requirement) Title() string

+ type RequirementAttribute struct

+ Index int

+ Label string

+ Name string

+ Value any

+ type RequirementQuestion struct

+ Description string

+ HelpText string

+ ID string

+ IsNew bool

+ ParticipantHelpText string

+ Question string

+ ResearcherHelpText string

+ Title string

+ type Secret struct

+ ID string

+ Value string

+ WorkspaceID string

+ type Study struct

+ AverageRewardPerHour float64

+ AwardPoints int

+ CanAutoReview bool

+ CompletionURL string

+ CurrencyCode string

+ DateCreated time.Time

+ Desc string

+ DeviceCompatibility []string

+ EligibilityRequirements []struct{ ... }

+ EstimatedCompletionTime int

+ EstimatedRewardPerHour float64

+ ExternalStudyURL string

+ Filters []Filter

+ ID string

+ InternalName string

+ IsPilot bool

+ IsUnderpaying any

+ MaximumAllowedTime int

+ Name string

+ PeripheralRequirements []any

+ PlacesTaken int

+ PresentmentCurrencyCode string

+ PublishAt any

+ PublishedAt any

+ Ref any

+ Researcher struct{ ... }

+ Reward float64

+ StartedPublishingAt any

+ Status string

+ StudyType string

+ SubmissionsConfig SubmissionsConfig

+ TotalAvailablePlaces int

+ TotalCost float64

+ func (s Study) Description() string

+ func (s Study) FilterValue() string

+ func (s Study) GetCurrencyCode() string

+ func (s Study) Title() string

+ type Submission struct

+ BonusPayments []any

+ CompletedAt time.Time

+ ID string

+ IP string

+ IsComplete bool

+ ParticipantID string

+ Reward int

+ StarAwarded bool

+ StartedAt time.Time

+ Status string

+ Strata struct{ ... }

+ StudyCode string

+ TimeTaken int

+ type SubmissionsConfig struct

+ MaxConcurrentSubmissions int

+ MaxSubmissionsPerParticipant int

+ type TaskDetails struct

+ TaskIntroduction string

+ TaskName string

+ TaskSteps string

+ type UnreadMessage struct

+ Body string

+ DatetimeCreated time.Time

+ Sender string

+ type UpdateStudy struct

+ TotalAvailablePlaces int

+ type User struct

+ Email string

+ ID string

+ Name string

+ Roles []string

+ type Workspace struct

+ Description string

+ ID string

+ Title string

+ Users []User