email-competitive

Search brands to add to the watchlist

Searches for brands by name and returns the ones that can be watched, each with the domain its figures would describe and the identifier to add it with. Paste a domain instead of a name to find the brand that sends from it.

Brands the panel has never seen send are left out, since no figure could be reported for them. Results are capped at eight and can omit matches whose sending domain could not be resolved. An empty result means no watchable match was returned for this query; try a more specific name or known sending domain.

get/v1/email/competitive/brands/search

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/competitive/brands/search
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

qstring required
Example:everlane

A brand name, or a sending domain to look up the brand behind it.

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

Brands matching the search.

Example response

{
  "data": [
    {
      "brand_id": "81531",
      "name": "Everlane",
      "sending_domains": [
        "everlane.com"
      ]
    }
  ]
}

Changes

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