email-inbox-insights

List sending domains and their Inbox Insights status

Returns a page of sending domains this workspace can report on, in alphabetical order by default, and whether Inbox Insights is switched on for each.

Only verified domains appear. Verifying a domain proves it is yours, which is what Inbox Insights needs before it will report on it, and a domain that loses its verification drops out of this list even if it was switched on.

A domain does not have to be ready to send to appear here. Verification and sending readiness are reported separately on your sending domains, and this list follows the first.

Use this list to select a verified domain for placement and reputation reports. The monitored field records the workspace's monitoring preference; report access depends on verified ownership and remains available when monitoring is off.

get/v1/email/inbox-insights/domains

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/inbox-insights/domains
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

sending_domainstring

Exact sending domain to return. Matching is case-insensitive.

searchstring

Substring match against the sending domain (case-insensitive).

sort'domain'

Field used to sort owned domains.

Example:domain

Field to sort by. Defaults to domain.

order'asc' | 'desc'

Sort direction, ascending or descending.

Sort direction. Defaults to asc, which sorts alphabetically or from oldest to newest, depending on the selected sort field.

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

A page of the workspace's sending domains and their Inbox Insights status.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "domain": "mail.acme.com",
      "monitored": true
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.