Query parameters

• fromDate object

  The date from which to start exporting activities (Unix timestamp format). You MUST provide either fromDate or fromEventId.

  Hide fromDate attribute Show fromDate attribute object

  • fromDate[eq] integer

    Search activities from this date

• fromEventId string

  The eventId from which to start exporting activities. You MUST provide either fromDate or fromEventId.

• toDate object

  The date until which to export activities (Unix timestamp format).

  Hide toDate attribute Show toDate attribute object

  • toDate[eq] integer

    Search activities to this date

• eventType object

  The event types to export. If not provided, all activities will be exported.

  Hide eventType attributes Show eventType attributes object

  • eventType[eq] string

    Search activities with a specific event type

    Values are ChannelJoined, ChannelLeft, ChannelMessageReacted, ChannelMessageSent, CourseStarted, CourseCompleted, CourseStepViewed, CourseStepCompleted, DiscussionMessageSent, DocumentLinkOpened, DocumentLinkReacted, DocumentPageReacted, DocumentPageViewed, LearningPathCompleted, LearningPathStarted, LiveAttended, LiveInvitationDeclined, LiveMessageReacted, LiveMessageSent, LiveParticipantRegistered, LiveReplayWatched, SpotMemberLeft, SpotMemberRegistered, SpotMemberRegistrationRequested, TopicAnswerCreated, TopicAnswerVoted, TopicCreated, or TopicVoted.

  • eventType[in] array[string]

    Search activities which have the following event types

    Values are ChannelJoined, ChannelLeft, ChannelMessageReacted, ChannelMessageSent, CourseStarted, CourseCompleted, CourseStepViewed, CourseStepCompleted, DiscussionMessageSent, DocumentLinkOpened, DocumentLinkReacted, DocumentPageReacted, DocumentPageViewed, LearningPathCompleted, LearningPathStarted, LiveAttended, LiveInvitationDeclined, LiveMessageReacted, LiveMessageSent, LiveParticipantRegistered, LiveReplayWatched, SpotMemberLeft, SpotMemberRegistered, SpotMemberRegistrationRequested, TopicAnswerCreated, TopicAnswerVoted, TopicCreated, or TopicVoted.

• limit string

  The limit of activities to export. If not provided, a default limit of 100 will be used.

  Minimum value is 1, maximum value is 10000. Default value is 100.

Responses

• 200 application/json

  Exported members activities as a stream of JSONL objects. If a streaming error occurs, a JSON error payload is returned.

  Hide response attributes Show response attributes object

  • type Required

    The activity type

    Values are ChannelJoined, ChannelLeft, ChannelMessageReacted, ChannelMessageSent, CourseStarted, CourseCompleted, CourseStepViewed, CourseStepCompleted, DiscussionMessageSent, DocumentLinkOpened, DocumentLinkReacted, DocumentPageReacted, DocumentPageViewed, LearningPathCompleted, LearningPathStarted, LiveAttended, LiveInvitationDeclined, LiveMessageReacted, LiveMessageSent, LiveParticipantRegistered, LiveReplayWatched, SpotMemberLeft, SpotMemberRegistered, SpotMemberRegistrationRequested, TopicAnswerCreated, TopicAnswerVoted, TopicCreated, or TopicVoted.

  • index string Required

    The activity index

  • event_id string Required

    The event id related to this activity

  • spot_id string Required

    The spot id related to this activity

  • occurred_at_tz string(date-time) Required

    The timestamp of the activity

  • member_id string Required

    The member id related to this activity

  • member_first_name string Required

    The member first name related to this activity

  • member_last_name string Required

    The member last name related to this activity

  • member_title string | null

    The member title related to this activity

  • member_profile_picture_url string | null

    The member profile picture URL related to this activity

  • member_role string | null

    The member role related to this activity

  • member_custom_role_id string | null

    The member custom role id related to this activity

  • member_custom_role_label string | null

    The member custom role label related to this activity

  • member_email string Required

    The member email related to this activity

  • recipient_member_id string | null

    The recipient member id related to this activity

  • recipient_member_first_name string | null

    The recipient member first name related to this activity

  • recipient_member_last_name string | null

    The recipient member last name related to this activity

  • recipient_member_title string | null

    The recipient member title related to this activity

  • recipient_member_profile_picture_url string | null

    The recipient member profile picture URL related to this activity

  • recipient_member_email string | null

    The recipient member email related to this activity

  • live_id string | null

    The live id related to this activity

  • live_title string | null

    The live title related to this activity

  • channel_id string | null

    The channel id related to this activity

  • channel_title string | null

    The channel title related to this activity

  • channel_emoji string | null

    The channel emoji related to this activity

  • thread_message_id string | null

    The thread id related to this activity

  • thread_message_preview string | null

    The thread message preview related to this activity

  • reaction_emoji string | null

    The reaction emoji related to this activity

  • document_id string | null

    The document id related to this activity

  • document_title string | null

    The document title related to this activity

  • document_type string | null

    The document type related to this activity

  • document_link string | null

    The document link related to this activity

  • collection_id string | null

    The collection id related to this activity

  • collection_title string | null

    The collection title related to this activity

  • course_id string | null

    The course id related to this activity

  • course_title string | null

    The course title related to this activity

  • course_step_id string | null

    The course step id related to this activity

  • course_step_title string | null

    The course step title related to this activity

  • course_step_type string | null

    The course step type related to this activity

  • course_step_quiz_correct_answers_count integer | null

    The course step quiz correct answers count related to this activity

  • course_step_quiz_total_questions_count integer | null

    The course step quiz total questions count related to this activity

  • collection_emoji string | null

    The collection emoji related to this activity

  • topic_id string | null

    The topic id related to this activity

  • topic_title string | null

    The topic title related to this activity

  • forum_id string | null

    The forum id related to this activity

  • forum_title string | null

    The forum title related to this activity

  • forum_emoji string | null

    The forum emoji related to this activity

  • score_vote integer | null

    The score vote related to this activity

  • learning_path_id string | null

    The learning path id related to this activity

  • learning_path_title string | null

    The learning path title related to this activity

• 400

  Malformed payload