API docs by Redocly

Data API (0.1-alpha)

Download OpenAPI specification:Download

API for fetching events data.

Pagination

  • Every response body is a JSON object containing events and pagination as top-level keys.
  • The pagination key contains next_page_uri and previous_page_uri if there is a next or previous page, respectively.
  • Use the next_page_uri to get the next page of events. This key will be absent if there is no next page.
  • Use the previous_page_uri to get the previous page of events. This key will be absent if there is no previous page.
  • Default and max pagination size/per_page is 2000.

Fetching incremental updates:

First sync:

  • Use this to sync all events from the beginning of time.
  • To do this, there is no need to pass any parameters (this returns page 1, 2000 events sorted by latest first).
  • Use the next_page_uri to get the next page of events.
  • Do this until you have fetched all the events.
  • Store the max created_at timestamp from the events you fetched or the start_time of the first sync process (in UTC time or time with timezone info). This will be used in incremental sync in the future.

Incremental sync/new events:

  • Pass the created_at_gt as a query parameter to get events created after the max created_at timestamp from the last sync.
  • Use the next_page_uri to get the next page of events.
  • Do this until you have fetched all the events.
  • Store the max created_at timestamp from the events you fetched; this will be used in the next incremental sync.

Rate limiting

  • The current rate limit is 600 requests per minute. This allows you to fetch a maximum of 2000 * 600 = 1,200,000 events per minute.
  • Status code 429 will be returned if you exceed the rate limit.

Other parameters

Difference between triggered_at and created_at

  • triggered_at: The time when the event was actually triggered in Circle.
  • created_at: The time when the event was created in Circle's database. As the process of storing the events is asynchronous, there might be a slight delay between the triggered_at and created_at timestamps.
  • They will also differ in case we are backfilling events. In this case, the triggered_at will be the time when the event was actually triggered, and created_at will be the time when the event was created in Circle's database.
  • created_at is the timestamp you should use for incremental sync, as triggered_at can be in the past in case of backfilling events.
  • We do backfilling when we add a new event type.

Creating an Airbyte source

Airbyte is an open-source data integration platform that helps you replicate your data in your warehouse. You can create an Airbyte source for Circle data Api by following the steps below. We assume you have already setup airbyte either the cloud version or the self-hosted version.
  • Download the latest YAML file from https://app.circle.so/data_api/docs/airbyte_connector.yaml
  • Screen recording on how to use the YAML file to create a new data source

Event payload models

Models for the event payloads

CommunityMember

type
string
Value: "CommunityMember"
public_uid
string
name
string
last_name
string
id
integer
first_name
string
email
string <email>
is_admin
boolean
is_moderator
boolean
{
  • "type": "CommunityMember",
  • "public_uid": "string",
  • "name": "string",
  • "last_name": "string",
  • "id": 0,
  • "first_name": "string",
  • "email": "user@example.com",
  • "is_admin": true,
  • "is_moderator": true
}

ChatRoomMessage

type
string
Value: "ChatRoomMessage"
chat_room_id
integer
id
integer
{
  • "type": "ChatRoomMessage",
  • "chat_room_id": 0,
  • "id": 0
}

ChatRoom

type
string
Value: "ChatRoom"
parent_id
integer
name
string
is_embedded
boolean
id
integer
uuid
string
{
  • "type": "ChatRoom",
  • "parent_id": 0,
  • "name": "string",
  • "is_embedded": true,
  • "id": 0,
  • "uuid": "string"
}

SpaceMember

type
string
Value: "SpaceMember"
community_member_id
integer
space_id
integer
{
  • "type": "SpaceMember",
  • "community_member_id": 0,
  • "space_id": 0
}

Space

type
string
Value: "Space"
name
string
id
integer
slug
string
{
  • "type": "Space",
  • "name": "string",
  • "id": 0,
  • "slug": "string"
}

Lesson

type
string
Value: "Lesson"
id
integer
{
  • "type": "Lesson",
  • "id": 0
}

Section

type
string
Value: "Section"
id
integer
space_id
integer
{
  • "type": "Section",
  • "id": 0,
  • "space_id": 0
}

PostsEvent

type
string
Value: "PostsEvent"
recurring
boolean
event_type
string
community_member_id
integer
name
string
record_owner_is_admin
boolean
id
integer
published_at
string <date-time>
space_id
integer
slug
string
status
string
{
  • "type": "PostsEvent",
  • "recurring": true,
  • "event_type": "string",
  • "community_member_id": 0,
  • "name": "string",
  • "record_owner_is_admin": true,
  • "id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "space_id": 0,
  • "slug": "string",
  • "status": "string"
}

PostsBasic

type
string
Value: "PostsBasic"
community_member_id
integer
name
string
record_owner_is_admin
boolean
id
integer
published_at
string <date-time>
space_id
integer
slug
string
status
string
{
  • "type": "PostsBasic",
  • "community_member_id": 0,
  • "name": "string",
  • "record_owner_is_admin": true,
  • "id": 0,
  • "published_at": "2019-08-24T14:15:22Z",
  • "space_id": 0,
  • "slug": "string",
  • "status": "string"
}

Comment

type
string
Value: "Comment"
post_id
integer
community_member_id
integer
record_owner_is_admin
boolean
id
integer
parent_comment_id
integer or null

is a valid integer when comment is a reply to another comment

{
  • "type": "Comment",
  • "post_id": 0,
  • "community_member_id": 0,
  • "record_owner_is_admin": true,
  • "id": 0,
  • "parent_comment_id": 0
}

RecurringEventSetting

object (RecurringEventSetting)
{ }

SpaceGroupMember

type
string
Value: "SpaceGroupMember"
community_member_id
integer
space_group_id
integer
id
integer
{
  • "type": "SpaceGroupMember",
  • "community_member_id": 0,
  • "space_group_id": 0,
  • "id": 0
}

MemberTag

type
string
Value: "MemberTag"
color
string
display_format
string
name
string
is_public
boolean
id
integer
{
  • "type": "MemberTag",
  • "color": "string",
  • "display_format": "string",
  • "name": "string",
  • "is_public": true,
  • "id": 0
}

All events

All the events that are supported by the system

chat_space.chat_rooms.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "chat_space.chat_rooms.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "chat_space.chat_rooms.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

chat_space.chat_rooms.message.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "chat_space.chat_rooms.message.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "chat_space.chat_rooms.message.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

community_member.create

id
string <uuid>

The unique identifier of the event

name
string
Value: "community_member.create"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "community_member.create",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

community_member.destroy

id
string <uuid>

The unique identifier of the event

name
string
Value: "community_member.destroy"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "community_member.destroy",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

community_member.email_changed

id
string <uuid>

The unique identifier of the event

name
string
Value: "community_member.email_changed"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "community_member.email_changed",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

community_member.joined_community

id
string <uuid>

The unique identifier of the event

name
string
Value: "community_member.joined_community"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "community_member.joined_community",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

course.lesson.chat_rooms.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "course.lesson.chat_rooms.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "course.lesson.chat_rooms.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

course.lesson.chat_rooms.message.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "course.lesson.chat_rooms.message.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "course.lesson.chat_rooms.message.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

courses.completed

id
string <uuid>

The unique identifier of the event

name
string
Value: "courses.completed"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "courses.completed",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

courses.lesson.completed

id
string <uuid>

The unique identifier of the event

name
string
Value: "courses.lesson.completed"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "courses.lesson.completed",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

courses.section.completed

id
string <uuid>

The unique identifier of the event

name
string
Value: "courses.section.completed"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "courses.section.completed",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

direct_chat_rooms.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "direct_chat_rooms.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "direct_chat_rooms.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

direct_chat_rooms.message.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "direct_chat_rooms.message.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "direct_chat_rooms.message.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

event.ended

id
string <uuid>

The unique identifier of the event

name
string
Value: "event.ended"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "event.ended",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

event.published

id
string <uuid>

The unique identifier of the event

name
string
Value: "event.published"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "event.published",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

event.rsvp

id
string <uuid>

The unique identifier of the event

name
string
Value: "event.rsvp"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "event.rsvp",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

group_chat_rooms.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "group_chat_rooms.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "group_chat_rooms.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

group_chat_rooms.message.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "group_chat_rooms.message.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "group_chat_rooms.message.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

live_event.ended

id
string <uuid>

The unique identifier of the event

name
string
Value: "live_event.ended"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "live_event.ended",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

live_stream.chat_rooms.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "live_stream.chat_rooms.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "live_stream.chat_rooms.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

live_stream.chat_rooms.message.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "live_stream.chat_rooms.message.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "live_stream.chat_rooms.message.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

post.basic.published

id
string <uuid>

The unique identifier of the event

name
string
Value: "post.basic.published"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "post.basic.published",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

post.comment.created

id
string <uuid>

The unique identifier of the event

name
string
Value: "post.comment.created"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "post.comment.created",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

post.comment.liked

id
string <uuid>

The unique identifier of the event

name
string
Value: "post.comment.liked"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "post.comment.liked",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

post.liked

id
string <uuid>

The unique identifier of the event

name
string
Value: "post.liked"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "post.liked",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

recurring_event.rsvp

id
string <uuid>

The unique identifier of the event

name
string
Value: "recurring_event.rsvp"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "recurring_event.rsvp",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

space_groups.joined

id
string <uuid>

The unique identifier of the event

name
string
Value: "space_groups.joined"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "space_groups.joined",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

space_groups.left

id
string <uuid>

The unique identifier of the event

name
string
Value: "space_groups.left"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "space_groups.left",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

spaces.joined

id
string <uuid>

The unique identifier of the event

name
string
Value: "spaces.joined"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "spaces.joined",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

spaces.left

id
string <uuid>

The unique identifier of the event

name
string
Value: "spaces.left"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "spaces.left",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

tagged_member.create

id
string <uuid>

The unique identifier of the event

name
string
Value: "tagged_member.create"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "tagged_member.create",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

tagged_member.destroy

id
string <uuid>

The unique identifier of the event

name
string
Value: "tagged_member.destroy"

The name of the event

triggered_at
string <date-time>

The time the event was triggered

created_at
string <date-time>

The time at which the event was stored in our DB! Used for only sorting purposes. Generally triggered realtime but stored in DB later. There will also be a big difference between triggered_at and created at for events that have been back populated.

version
string

The version of the event

object

The payload of the event

{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "tagged_member.destroy",
  • "triggered_at": "2019-08-24T14:15:22Z",
  • "created_at": "2019-08-24T14:15:22Z",
  • "version": "string",
  • "payload": {
    }
}

Fetch community events data

Retrieve events data based on various query parameters.

Authorizations:
bearerAuth
query Parameters
per_page
integer

Number of events per page

page
integer

Page number for pagination

base_timestamp
number <float>
Example: base_timestamp=1727848462.295174

Used for consistent pagination. Only events generated before this timestamp are fetched.

sort
string
Enum: "latest" "oldest"

Sort order of the events

from_date
string <date-time>

Filter events from this date. Example: 2024-04-18T05:49:39-06:00

to_date
string <date-time>
Example: to_date=2024-08-11T23:35:14-06:00

Filter events to this date

created_at_gt
string <date-time>

Filter events emitted after this date

events
Array of strings
Items Enum: "chat_space.chat_rooms.created" "chat_space.chat_rooms.message.created" "community_member.create" "community_member.destroy" "community_member.email_changed" "community_member.joined_community" "course.lesson.chat_rooms.created" "course.lesson.chat_rooms.message.created" "courses.completed" "courses.lesson.completed" "courses.section.completed" "direct_chat_rooms.created" "direct_chat_rooms.message.created" "event.ended" "event.published" "event.rsvp" "group_chat_rooms.created" "group_chat_rooms.message.created" "live_event.ended" "live_stream.chat_rooms.created" "live_stream.chat_rooms.message.created" "post.basic.published" "post.comment.created" "post.comment.liked" "post.liked" "recurring_event.rsvp" "space_groups.joined" "space_groups.left" "spaces.joined" "spaces.left" "tagged_member.create" "tagged_member.destroy"

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "events": [
    ]
}

Fetch community members visits data

Retrieve community member visits based on various criteria.

Authorizations:
bearerAuth
query Parameters
per_page
integer

Number of events per page

page
integer

Page number for pagination

base_timestamp
number <float>
Example: base_timestamp=1727848462.295187

Used for consistent pagination. Only events generated before this timestamp are fetched.

sort
string
Enum: "latest" "oldest"

Sort order of the events

from_date
string <date-time>

Filter events from this date. Example: 2024-04-18T05:49:39-06:00

to_date
string <date-time>
Example: to_date=2024-08-11T23:35:14-06:00

Filter events to this date

created_at_gt
string <date-time>

Filter events emitted after this date

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "events": [
    ]
}