Activity

List activity

Lists activity events for the current organization.

get/v1/activity

Request

  • Base URL: https://api.talktohumans.app
  • URL: https://api.talktohumans.app/v1/activity
  • Auth: HTTP bearer

Query parameters

fromstring

Inclusive activity window start. Use RFC3339 or YYYY-MM-DD. Date-only values are interpreted in the requested timezone.

tostring

Exclusive activity window end. Use RFC3339 or YYYY-MM-DD. Date-only values are interpreted in the requested timezone and advance to the start of the following local day. The response repeats the normalized instant in filters.to with to_exclusive: true.

timezonestring

IANA timezone used for date-only from and to filters. Defaults to UTC.

account_idstring[]

Filter by TalkToHumans LinkedIn account ID in activity facts. Repeat the query parameter for multiple accounts. The backend also accepts comma-separated values.

user_idstring[]

Filter by TalkToHumans user ID in activity facts. Repeat the query parameter for multiple users. The backend also accepts comma-separated values.

event_typeActivityEventType[]

Filter by activity event type. Repeat the query parameter for multiple event types. The backend also accepts comma-separated values.

channelstring[]

Filter by activity channel, such as linkedin_message, linkedin_inmail, or linkedin_connection. Repeat the query parameter for multiple channels. The backend also accepts comma-separated values.

sourcestring[]

Filter by activity emitter source, such as canonical_messages, canonical_chats, canonical_sequence_steps, sequence_runner_report, or canonical_account_participants. Repeat the query parameter for multiple sources. The backend also accepts comma-separated values.

tagstring

Reserved for future tag-attributed reporting. Passing this parameter currently returns 400 bad_request.

limitinteger

Page size for GET /v1/activity. Defaults to 50 and must be between 1 and 200.

cursorstring

Opaque cursor from the previous GET /v1/activity response's pagination.next_cursor.

Response

Activity rows.

Example response

{
  "data": {
    "activity": [
      {
        "source": "canonical_messages",
        "channel": "linkedin_message"
      }
    ],
    "pagination": {
      "limit": 50
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.