List Email Activity

Lists a sent campaign's activity feed (delivered / open / click / bounce / unsubscribe events plus attributed orders) from the stored feed. Paginated; filter to one kind with 'view', search recipients with 'search'. Call sync_email_activity first if the feed looks stale.

Authorization

AuthorizationRequiredBearer <token>

API key as Bearer token

In: header

Path Parameters

idRequiredstring

Email id, discoverable via list_emails

Query Parameters

pageNumberinteger

Default: 0Minimum: 0Maximum: 9007199254740991

pageSizeinteger

Default: 20Minimum: 0Maximum: 500

filtersstring

JSON-encoded FilterGroup[] for view / custom filtering.

searchstring

Case-insensitive recipient substring.

sortFieldstring

Whitelist of fields which can be sorted by when listing activity.

Value in: "timestamp" | "recipient" | "eventType"

sortDirectionstring

Value in: "asc" | "desc"

GET/v1/email/{id}/activity

curl -X GET "https://api.3common.com/v1/email/string/activity?filters=string&search=string&sortField=timestamp&sortDirection=asc" \
  -H "Authorization: Bearer <token>"

Default Response

Response

{
  "hasMore": true,
  "pageNumber": 0,
  "pageSize": 0,
  "data": [
    {
      "id": "string",
      "emailId": "string",
      "recipient": "string",
      "eventType": "delivered",
      "timestamp": 0,
      "url": "string",
      "bounceClass": "string",
      "reason": "string",
      "orderId": "string",
      "amount": -9007199254740991
    }
  ]
}

TypeScript

export interface Response {
  hasMore: boolean;
  pageNumber: number;
  pageSize: number;
  data: {
    id: string;
    emailId: string;
    recipient: string;
    /**
     * Kind of activity row in the campaign report feed. All but 'order' map to
     * Sparkpost message-events; 'order' is a conversion row attributed via the
     * Referral + View join. 'initial_open' (first open) is tracked separately from
     * 'open' (any open, incl. mail-client prefetch).
     */
    eventType: "delivered" | "open" | "initial_open" | "click" | "bounce" | "unsubscribe" | "spam_complaint" | "order";
    /**
     * Event time, epoch ms.
     */
    timestamp: number;
    url?: string;
    bounceClass?: string;
    reason?: string;
    orderId?: string;
    amount?: number;
  }[];
}