Home
API Reference

Search activity

post
https://api.smtp2go.com/v3/activity/search

Returns events (such as opens, unsubscribes) which match the filters passed. A count of events matching the filter is also included, as this may surpass the maximum of 1,000 items included within the response.
This endpoint is rate-limited to 60 requests per minute.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string

ISO-8601 formatted datetime which defaults to now. Timezone is UTC.Defaults to current date at midnight.

Valid formats are: 2006-01-02, 2006-01-02 15:04:05, 2006-01-02T15:04:05, 2006-01-02T15:04:05.0000000, 02 Jan 06 15:04 MST, 02 Jan 06 15:04 -0700, 2006-01-02T15:04:05Z07:00, 2006-01-02T15:04:05.999999999Z07:00, Mon, 02 Jan 2006 15:04:05 MST

string

If passed, will return all events for emails containing this string in any search fields. To return events with one or more text values, separate the text with '|' (e.g. 'text1 | text2')

string

If passed, will return all events for an email matching this specific id

string

If passed, will return all events for emails containing this string in the email subject

string

If passed, will return all events for emails containing this string in the email sender

string

If passed, will return all events for emails containing this string in the email recipient

search_usernames
array of strings

If passed, will return all events for emails sent by this/these username/s

search_usernames
subaccounts
array of strings

If passed, will return all events for emails sent by this/these subaccount_id/s (as returned from the /subaccount/search endpoint or as shown in the App)

subaccounts
int32
Defaults to 100

The maximum number of events to return (Max: 1000)

string

If passed, will continue the search beyond the current page, using the same search parameters

boolean

If true, will only return the most recent event for each email returned. Default: false

boolean

If true, will only return the most recent event for each email returned ordered by sent date (overrides only_latest field). Default: false

event_types
array of strings

If passed, will limit the returned events to the provided event types.

Values: 'processed', 'soft-bounced', 'hard-bounced', 'rejected', 'spam', 'delivered', 'unsubscribed', 'resubscribed', 'opened', 'clicked'

event_types
boolean
Defaults to false

Return the full email headers with the response

custom_headers
array of strings

A list of header keys to parse out of the raw headers

custom_headers
Responses

Updated 8 months ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago