Messages

List message analytics

List an organization-wide, analytics-safe message projection in stable ascending (updated_at, id) order. The first page is bounded by updated_before, which cannot be later than the server's current time, or by the server's current time when omitted; subsequent pages retain that snapshot in the signed cursor. The projection excludes subjects, BCC addresses, headers, free-form metadata, attachment filenames, auto-reply content, and message bodies. contact_addresses contains personal data. client_reference is caller-defined and may contain personal or customer data.

get/messages/analytics

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/messages/analytics
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Query parameters

updated_afterstring date-time

Inclusive lower bound for updated_at. Use the previous completed sync's snapshot_at to begin the next sync.

updated_beforestring date-time

Exclusive upper bound for updated_at. Must not be later than the server's current time and defaults to the server time captured for the first page.

cursorstring

Opaque pagination cursor returned by the same list operation. Send it unchanged; do not parse, modify, or fabricate it.

limitinteger

Number of items to return (1-100, default 25).

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Response

A bounded page of analytics-safe messages.

Changes

No recorded changes to this operation across all 1 revision of this API.