Unblu Agent Embedded JS API
    Preparing search index...

    Interface ParticipantHistoryData

    Information about a participant in a conversation (with historical information)

    interface ParticipantHistoryData {
        activationTimestamp?: number;
        conversationRating?: number;
        createdTimestamp: number;
        hidden: boolean;
        joinedTimestamp?: number;
        leftComment?: string;
        leftReason?: string;
        leftTimestamp?: number;
        offboardingTimestamp?: number;
        person: PersonData;
        personId: string;
        state: ParticipationState;
    }
    Index

    Properties

    activationTimestamp? conversationRating? createdTimestamp hidden joinedTimestamp? leftComment? leftReason? leftTimestamp? offboardingTimestamp? person personId state

    Properties

    activationTimestamp?: number

    Unix timestamp (ms) when the participation was activated, that is, when their participation state was set to ParticipationState.ACTIVE. null if the participation was never activated.

    conversationRating?: number

    Participant's rating of the conversation, expressed as a value between 0 and 1

    createdTimestamp: number

    Unix timestamp (ms) when the person participation was created and their participation state was set to ParticipationState.CREATED

    hidden: boolean

    Indicates if the participant is hidden in the current conversation

    joinedTimestamp?: number

    Unix timestamp (ms) when the person joined, that is, when their participation state was set to ParticipationState.ONBOARDING

    leftComment?: string

    The comment on why the participant left the conversation. Set when offboarding starts, null if the participant is still part of the conversation.

    leftReason?: string

    The reason the participant left the conversation. Set when offboarding starts, null if the participant is still part of the conversation.

    leftTimestamp?: number

    Unix timestamp (ms) when the person left, that is, when their participation state was set to ParticipationState.ENDED). null if the participation didn't finish its offboarding.

    offboardingTimestamp?: number

    Unix timestamp (ms) when the person started offboarding, that is, when their participation state was set to ParticipationState.OFFBOARDING. null if the participation never started its offboarding.

    person: PersonData

    The participant person

    personId: string

    The participant person's ID

    state: ParticipationState

    The participant's participation state

    Settings

    Member Visibility

    On This Page

    Properties