How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Bird Email Competitive API

Watch competitor brands and see how their email compares with yours. Figures about a competitor are estimates from an email panel, which observes a sample of real inboxes; figures about your own sending are counted rather than estimated wherever that is possible.

Bird Email Competitive API is one of 65 APIs that Bird publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include email-competitive. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 10 operations across 9 paths, and defines 40 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 3 base URLs: https://{region}.platform.bird.com, https://platform.bird.com, http://localhost:8080.

10 operations 9 paths 40 schemas 1 DELETE8 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.bird.com
Authentication
HTTP Bearer, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 4

Bird Email Competitive API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (BearerAuth). An API key is passed in the cookie as bird_session (CookieAuth). An API key is passed in the header as X-Realtime-Key (RealtimeKey). An API key is passed in the header as X-Realtime-Secret (RealtimeSecret). By default, every request must be authenticated.

  • BearerAuth — Pass the API key as a bearer token in the Authorization header. Keys use the format bk{region}. The prefix identifies the region and selects the API endpoint.…
  • CookieAuth — Session cookie set after signing in to the Bird dashboard. The cookie value is an opaque session token; no session data is stored in the cookie itself.
  • RealtimeKey — The Realtime app key. Together with X-Realtime-Secret, it authenticates a request to the Realtime API in addition to the workspace credential. Both values come…
  • RealtimeSecret — The Realtime app secret paired with X-Realtime-Key. The API returns the secret only when the key is created and does not store it. Create a new key and revoke…

Paths & Operations 10

Across 9 paths, the API surfaces 10 operations — 1 DELETE, 8 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

email-competitive 10

Watch competitor brands and see how their email compares with yours. Figures about a competitor are estimates from an email panel, which observes a sample of real inboxes; figures…

GET
/v1/email/competitive/watchlist
Get the competitor watchlist with its latest figures
getEmailCompetitiveWatchlist 1 param → 200400401403404422429500
GET
/v1/email/competitive/watchlist/notable
Get the notable campaigns across watched brands
getEmailCompetitiveNotableCampaigns 1 param → 200400401403404422429500
POST
/v1/email/competitive/watchlist/brands
Add a competitor brand to the watchlist
createEmailCompetitiveWatchlistBrand 1 param body → 201400401403404409422429
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}
Get a watched brand's figures
getEmailCompetitiveBrand 2 params → 200400401403404422429500
DELETE
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}
Remove a competitor brand from the watchlist
deleteEmailCompetitiveWatchlistBrand 2 params → 204401403404422429500503
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/campaigns
Get the campaigns a watched brand sent
getEmailCompetitiveBrandCampaigns 7 params → 200400401403404422429500
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/campaigns/{campaign_id}
Get one campaign a watched brand sent
getEmailCompetitiveBrandCampaign 2 params → 200400401403404422429500
GET
/v1/email/competitive/watchlist/brands/{watchlist_brand_id}/send-time
Get when a watched brand sends
getEmailCompetitiveBrandSendTime 2 params → 200400401403404422429500
GET
/v1/email/competitive/brands/search
Search brands to add to the watchlist
searchEmailCompetitiveBrands 1 param → 200400401403404422429500
GET
/v1/email/competitive/volume-series
Get send volume over time for watched brands
getEmailCompetitiveVolumeSeries 2 params → 200400401403404422429500

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are EmailCompetitiveWatchlistRow (16 properties), ErrorBody (11 properties), EmailCompetitiveNotableCampaign (7 properties), EmailCompetitiveBrandSeries (7 properties). Each schema is shown below with its type and property counts.

_ListEnvelope
object
3 properties 3 required
ErrorDetail
object
2 properties 2 required
EmailCompetitiveFieldSource
string
Where a figure came from. measured means it is counted from your own sending. panel means it is an estimate from an email panel, which observes a sample of rea…
EmailCompetitiveNotableClaim
object
What the panel itself asserts about a campaign, in its own words. Present only on the campaigns the panel chose to make a claim about, which is a minority of t…
1 property 1 required
ErrorBody
object
11 properties 6 required
EmailCompetitiveBrandID
string
Identifier of the brand in the panel's catalog, used to add it to the watchlist. It is a string for the same reason a campaign id is: the values are wide enoug…
EmailCompetitiveBrandSearchResults
object
Brands matching the search. Ranked by how well they match, best first, and capped at 8 results because this backs a type-ahead. The panel's own answer is often…
1 property 1 required
Timezone
string
IANA timezone identifier, such as America/NewYork, Europe/Amsterdam, or UTC.
NextAction
object
5 properties 2 required
Timestamps
object
2 properties 2 required
EmailCompetitiveVolumePoint
object
One day of one line on the volume chart.
2 properties 2 required
EmailCompetitivePanelStatus
string
Whether panel figures are available for a row, and when they are not, why. ok means the panel reported figures for the requested period. notinpanel means the p…
EmailCompetitiveSendTimeCell
object
One weekday and hour of a brand's sending week.
5 properties 5 required
CompetitiveWatchlistBrandID
string
EmailCompetitivePeriod
object
The period every figure in the response covers, echoed back from the request. Figures are fetched when the request is made, so they are current as of to. The p…
3 properties 3 required
EmailCompetitiveWatchlistSummary
object
Where your sending sits against the brands you watch, over the same period as the rows. Every figure here is derived from those rows rather than measured separ…
6 properties 6 required
EmailCompetitiveWatchlistBrandCreate
object
The brand to add to the watchlist. Obtained from a brand search, which only returns brands that can be watched.
1 property 1 required
EmailCompetitiveWatchlistRowProvenance
object
Where each figure on the row came from, so a comparison can be labelled honestly. Every field on a competitor's row is a panel estimate. On your own row the so…
6 properties 6 required
EmailCompetitiveCampaignSummary
object
The most recent campaign observed for a brand in the period.
4 properties 4 required
EmailCompetitiveNotableEvidence
object
The figures behind a campaign's signal, for ordering or filtering the list yourself. Which field carries a value depends on the signal, and each is null both o…
4 properties 4 required
EmailCompetitiveNotableCampaign
object
A campaign the panel surfaced, and the reason it did.
7 properties 7 required
EmailCompetitiveWatchlistBrand
A brand on the workspace's watchlist. This is the watchlist entry itself, with no figures on it; read the watchlist to get those.
EmailCompetitiveVolumeSeries
object
Volume over time for the requested watched brands, plus your own sending, on one shared daily axis.
2 properties 2 required
EmailCompetitiveBrandSeries
object
One line on the volume chart: a watched brand's sending over time, or your own.
7 properties 6 required
EmailCompetitiveCampaignFeed
A page of campaigns returned for a watched brand over the period.
EmailCompetitiveCampaignSort
string
Field used to sort campaigns.
EmailCompetitiveWatchlist
object
The workspace's competitor watchlist with its figures for the requested period. The list is capped by the organization's competitor limit and is returned whole…
3 properties 3 required
EmailCompetitiveSendTimePeak
object
The hour of the day a brand sends most of its mail in.
3 properties 3 required
Error
object
1 property 1 required
EmailCompetitiveWeekday
string
A day of the week. Named rather than numbered because the two common numberings disagree about which day the week starts on.
EmailCompetitiveBrandMatch
object
A brand matching a search, ready to be added to the watchlist.
3 properties 3 required
EmailCompetitiveSendTimeGrid
object
When a watched brand sends, by weekday and hour of the day.
5 properties 5 required
EmailCompetitiveWatchlistRow
object
One brand on the watchlist, with its figures for the requested period. Your own workspace appears as a row too, so the table can be read as a single ranking. E…
16 properties 15 required
EmailCompetitiveProviderPlacement
object
How one mailbox provider treated a brand's mail, beside your own.
4 properties 4 required
EmailCompetitivePanelMailboxProvider
string
A mailbox provider, as the email panel identifies it. A lowercase identifier rather than a display name, so pick your own label for it, and treat the set as op…
EmailCompetitiveCampaignSignal
string
Why this campaign was surfaced. The set is open and grows as new signals are added. Every signal describes the campaign against its own brand's history, never…
SortOrder
string
Sort direction, ascending or descending.
EmailCompetitiveBrandProfile
object
One watched brand's figures for the period, with its placement broken out by mailbox provider.
3 properties 3 required
EmailCompetitiveNotableFeed
object
Campaigns worth a second look across the brands a workspace watches.
4 properties 4 required
EmailCompetitiveCampaign
One campaign an email panel observed a brand sending.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bird-email-competitive-api-openapi.yml Raw ↑

Other APIs Bird publishes across the network.

Bird Customer Data API
Bird Phone Numbers API
Bird Identity Verification API
Bird Touchpoints API
Bird Accounts API
Bird FAQ API
Bird Intent API
Bird SMS Messaging API
Bird Channels API
Bird Contacts API
Bird Conversations API
Bird Legacy MessageBird API
Where this information came from

This is an independent, third-party profile of Bird Email Competitive API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.