Skip to main content
Retrieve an activity log

Authorizations

Authorization
string
header
required

A Tightknit admin API key, sent as Authorization: Bearer <key>.

Path Parameters

activity_log_id
string
required

The activity log's id.

Pattern: ^alog_[a-zA-Z0-9]{12}$

Query Parameters

expand

Repeatable. Returns the named relation inline. One of: initiator, recipient.

Available options:
initiator,
recipient

Response

Success

object
enum<string>
required

Always activity_log.

Available options:
activity_log
id
string
required

Unique identifier for the object.

Example:

"alog_4h2o89z6qlpw"

created_at
string<date-time>
required

When the activity was recorded, which is what lists are ordered by.

occurred_at
string<date-time>
required

When the activity happened. Earlier than created_at for activity recorded after the fact.

type
enum<string>
required

What happened. One of:

  • answer.marked_best: a reply already marked as an answer was promoted to its post’s best answer.
  • answer.selected: a reply was marked as an answer on a post.
  • answer.unselected: a reply was unmarked as an answer on a post.
  • award.given: an award was given to a member.
  • badge.given: a badge was given to a member, recorded before awards replaced badges; each one is also listed as an award.given.
  • calendar_event.user_registered: a member registered for an event, or an admin registered them.
  • calendar_event.user_unregistered: a member unregistered from an event, or an admin unregistered them.
  • comment.created: a member commented on a post.
  • comment.deleted: a comment was deleted.
  • comment.edited: a comment was edited.
  • journey.completed: a member completed a journey.
  • milestone.completed: a member completed a milestone.
  • poll.created: a poll was created.
  • poll.vote_added: a member voted on a poll. Served only while the poll’s results_visible is true, and with no initiator when its voter_identity_visibility is not public.
  • post.created: a member created a post.
  • post.deleted: a post was deleted.
  • post.edited: a post was edited.
  • site.auth.login_failure: a sign-in attempt on the community site failed.
  • site.auth.login_success: a member signed in to the community site.
  • slack_channel.member_joined: a member joined a Slack channel.
  • slack_message.created: a top-level Slack message was posted in a community channel.
  • slack_message.threaded_reply.created: a threaded reply was posted in a community channel.
  • slack_reaction.added: an emoji reaction was added to a Slack message.
  • slack_reaction.removed: an emoji reaction was removed from a Slack message.
  • slack_profile.photo.updated: a member set a custom Slack profile photo.
  • workspace.user_joined: a user joined the Slack workspace.
Available options:
badge.given,
calendar_event.user_registered,
calendar_event.user_unregistered,
comment.created,
slack_message.created,
slack_message.threaded_reply.created,
slack_reaction.added,
slack_reaction.removed,
post.created,
workspace.user_joined,
journey.completed,
milestone.completed,
award.given,
poll.created,
poll.vote_added,
post.edited,
comment.edited,
post.deleted,
comment.deleted,
site.auth.login_success,
site.auth.login_failure,
slack_profile.photo.updated,
answer.selected,
answer.unselected,
answer.marked_best,
slack_channel.member_joined
Example:

"award.given"

initiator_id
string | null
required

The member who acted. Null when no member did, when that member has been forgotten, or when they should not be identified.

Example:

"prof_9f2b8c1d4e5a"

recipient_id
string | null
required

The member acted upon, such as the one reacted to, replied to or given an award. Null when the type has none.

Example:

"prof_5Yq7tVz2Hm3n"

metadata_version
string
required

The version of the activity_metadata shape this activity was recorded under.

Example:

"0.08"

activity_metadata
object
required

What the activity recorded at the time, such as labels and text snippets, plus the public id of each record it involved. An id reads as null once that record is gone or its member has been forgotten. A Slack channel keeps Slack's own id, and so does a Slack user who has not been forgotten. The keys differ per type.

Example:
initiator
object | null

The member who acted. Present only when initiator is expanded.

recipient
object | null

The member acted upon. Present only when recipient is expanded.