Skip to main content
GET
/
api
/
contact
/
events
Get account contact events
curl --request GET \
  --url https://api-{region}-{cluster}.benchmarkemail.com/api/contact/events \
  --header 'X-API-Key: <api-key>'
{
  "records": [
    {
      "contactId": "<string>",
      "emailBounceDiagCode": "<string>",
      "emailBounceSubType": "<string>",
      "emailBounceType": "<string>",
      "emailCampaignId": "<string>",
      "emailCampaignName": "<string>",
      "emailComplaintFeedbackType": "<string>",
      "emailDelayType": "<string>",
      "emailLinkId": "<string>",
      "emailRejectReason": "<string>",
      "emailSender": "<string>",
      "emailSenderName": "<string>",
      "emailSmtpResponse": "<string>",
      "emailSubject": "<string>",
      "emailTargetUrl": "<string>",
      "emailTo": "<string>",
      "importId": "<string>",
      "importOriginalFileName": "<string>",
      "source": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "triggeredBy": {
        "type": "<string>",
        "userId": "<string>"
      },
      "type": "<string>"
    }
  ],
  "total": 123
}

Authorizations

X-API-Key
string
header
required

API key authentication

Query Parameters

types
enum<string>[]

Filter events by type

Available options:
contact-created,
contact-updated,
contact-update-failed,
contact-unsubscribed,
contact-reactivated,
email-sent,
email-bounced,
email-delivered,
email-delayed,
email-rejected,
email-complaint,
email-opened,
email-clicked,
email-skipped
pastDays
integer
default:30

Filter events from the last N days (1-90). Defaults to 30 when omitted

Required range: 1 <= x <= 90
page
integer

page number

Required range: x >= 1
size
integer

page size

Required range: x >= 1

Response

Contact events for the account

records
object[]
total
integer