List Newsletter Email Events

Lists Sparkpost bounce or open events for a sent newsletter. Returns one cursor-paginated page. Events outside the (date_sent - 1 day, now + 1 day) window aren't returned even if Sparkpost has them.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Newsletter id, discoverable via list_newsletters

Query Parameters

eventRequiredstring

Sparkpost event class to fetch.

bounce: hard/soft bounce, with reason + error code
open: unique open events

Value in: "bounce" | "open"

cursorstring

Sparkpost cursor token; omit for the first page

pageSizeinteger

Items per page (default 50, max 100)

Default: 50Minimum: 1Maximum: 100

GET/v1/newsletters/{id}/events

curl -X GET "https://api.3common.com/v1/newsletters/string/events?event=bounce&cursor=string" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "data": [
    {
      "recipient": "string",
      "event_type": "string",
      "timestamp": "string",
      "bounce_class": "string",
      "error_code": "string",
      "reason": "string",
      "user_agent": "string",
      "ip": "string",
      "click_tracking": true
    }
  ],
  "hasMore": true,
  "cursor": "string",
  "nextCursor": "string",
  "pageSize": -9007199254740991
}

TypeScript

export interface Response {
  data: {
    recipient: string;
    event_type: string;
    timestamp: string;
    bounce_class?: string;
    error_code?: string;
    reason?: string;
    user_agent?: string;
    ip?: string;
    click_tracking?: boolean;
  }[];
  hasMore: boolean;
  cursor: string;
  nextCursor: string | null;
  pageSize: number;
}