Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
Events API

Fetch Logs

Retrieves a paginated list of email event logs with multiple filtering options. You can filter logs by time range, event type, recipient details, sender details, and more. Supported Authorization type is “Bearer” along with value of your Email API KEY Which you can find in your Email API account under Settings >Integrations > API. This endpoint supports scroll-based pagination via the scrollId mechanism. The maximum number of records per request is 1000. If no limit is specified, 50 records will be returned. Supported event types: processed, sent, open, click, unsubscribe, bounce, softbounce, spam, invalid, dropped, hardbounce, scheduled, cancelled

get/messages

Query parameters

start_datestring date required
Example:2024-03-01

Start date in YYYY-MM-DD format (required).

end_datestring date
Example:2024-03-31

Optional end date in YYYY-MM-DD format.

event_start_datestring date-time required
Example:2024-03-01 00:00:00

Start date and time in YYYY-MM-DD HH:mm:ss format (required).

event_end_datestring date-time
Example:2024-03-31 23:59:59

Optional end date and time in YYYY-MM-DD HH:mm:ss format.

eventsstring[]

Optional list of event types to filter logs by.

emailstring

Filter by recipient email address.

subjectstring

Filter by email subject.

custom_argsstring

Filter by custom arguments passed in the email payload.

tagsstring

Filter by tags.

fromaddressstring

Filter by sender's email address.

fromdomainstring

Filter by sender's domain.

recipient_domainstring

Filter by recipient's domain.

message_idstring

Filter logs based on message_id

limitinteger
Example:100

Number of records to return. Maximum: 1000.

sort'asc' | 'desc'

Sort order for the logs based on sent time. Use asc or desc.

scrollidstring
Example:DXF1ZXJ5QW5kRmV0Y2gBAAAAAACXzVwWTXZBaGJGOE5UZW1vWGxabjhfM0JnQQ==

Scroll ID for fetching the next page of results.

Headers

on_behalf_ofstring
Example:subaccount_username

Optional header used when making API calls with a master account’s API key. Allows performing actions for a specific subaccount by providing its username.

Response

Logs fetched successfully.

dataobject[]
scrollIdstring