SAsalesforge
Analytics

List sent messages

Returns sent emails and LinkedIn messages for up to 10 sequences within a mandatory date range of at most 30 days. Results are ordered by send time, oldest first unless order=desc, and paginated: follow nextCursor until hasMore is false. No total count is returned.

get/multichannel/workspaces/{workspaceID}/analytics/messages

Request

  • Base URL
    https://multichannel-api.salesforge.ai/public
  • Auth
    API key in header Authorization

Path parameters

workspaceIDstring required

Workspace ID

Query parameters

sequence_idsinteger[] required

Sequence IDs, 1-10. Repeat the parameter per id: sequence_ids=1&sequence_ids=2

from_datestring required

Start date (inclusive, YYYY-MM-DD)

to_datestring required

End date (inclusive, YYYY-MM-DD). The range from from_date to to_date can span at most 30 days

timezonestring

IANA time zone name, for example America/New_York, used to resolve the dates to start and end of day (default UTC)

channel'email' | 'linkedin'

Restrict to one channel (default: both)

engagement'replied' | 'opened' | 'bounced' | 'clicked'

Restrict to messages that were replied to, opened, bounced or had a link clicked. opened, bounced and clicked apply to email only. Out-of-office email replies are not counted as replies

lead_idsstring[]

Only messages sent to these contacts, 1-50 unique ids. Repeat the parameter per id: lead_ids=a&lead_ids=b

message_type'message' | 'inmail' | 'connection_note'

Only this kind of LinkedIn message. Emails are not returned when set

lead_status'active' | 'paused' | 'completed' | 'failed' | 'replied' | 'out_of_office' | 'unsubscribed' | 'dnc' | 'bounced' | 'bounce-shield' | 'company_limit_reached' | 'stop_on_reply'

Only leads with this status in the sequence

sender_profile_idinteger

Only messages sent from this sender profile

order'asc' | 'desc'

Sort by send time: oldest first or newest first (default asc)

cursorstring

Value of nextCursor from the previous response, valid only in the same workspace. Send it back unchanged with the same filters and order. Omit for the first page

limitinteger

Maximum messages per page

Response

OK

hasMoreboolean

True when more messages follow this page.

limitinteger

The maximum number of messages on a page.

nextCursorstring

The value to send as cursor to get the next page. Present only when hasMore is true.

Changes

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