Search brands to add to the watchlist

GET

/v1/email/competitive/brands/search

// Requires Insights preview access for the organization.
const report = await bird.email.competitive.brands.search({ q: "Everlane" });
console.log(report.data);

# Requires Insights preview access for the organization.
report = client.email.competitive.brands.search(q="Everlane")
print(report.model_dump_json())

// Requires Insights preview access for the organization.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
	log.Fatal(err)
}
ctx := context.Background()
report, err := client.Email.Competitive.Brands.Search(ctx, bird.EmailCompetitiveBrandsSearchParams{Q: "Everlane"})
if err != nil {
	log.Fatal(err)
}
encoded, err := json.MarshalIndent(report, "", "  ")
if err != nil {
	log.Fatal(err)
}
fmt.Println(string(encoded))

// Requires Insights preview access for the organization.
$report = $bird->email->competitive->brands->search(['q' => 'Everlane']);
var_dump($report->getData());

bird email competitive brands search <q>

curl -X GET "https://us1.platform.bird.com/v1/email/competitive/brands/search" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "q=everlane"

Reactie200

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

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. An empty result for a real brand name therefore means the panel does not track that brand rather than that the search failed.

API-key calls require Insights preview access for your organization.

Queryparameters

string

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

Response Payload

data

array of object

verplicht

Matching brands. Empty when nothing matched, which for an unusual brand name means the panel does not track it rather than that the search failed.

Onderliggende attributen tonen

data.brand_id

string

verplicht

data.name

string

verplicht

The brand's name.

data.sending_domains

array of string

verplicht

The domains this brand's figures would describe. Always one domain today, chosen as the one the panel sees the most of its mail from.

Gerelateerde bronnen

Ga verder met de documentatie, gidsen en voorbeelden voor dit onderwerp. De bronnen zijn in het Engels.

Begrijp het conceptShould I use a Bird SDK or call the API directly?Volg het leerpadBuild your first integration ImplementatiegidsSend your first email

Ontvang een implementatieoverzicht

// Requires Insights preview access for the organization.
const report = await bird.email.competitive.brands.search({ q: "Everlane" });
console.log(report.data);

# Requires Insights preview access for the organization.
report = client.email.competitive.brands.search(q="Everlane")
print(report.model_dump_json())

// Requires Insights preview access for the organization.
client, err := bird.NewClient(option.WithAPIKey(os.Getenv("BIRD_API_KEY")))
if err != nil {
	log.Fatal(err)
}
ctx := context.Background()
report, err := client.Email.Competitive.Brands.Search(ctx, bird.EmailCompetitiveBrandsSearchParams{Q: "Everlane"})
if err != nil {
	log.Fatal(err)
}
encoded, err := json.MarshalIndent(report, "", "  ")
if err != nil {
	log.Fatal(err)
}
fmt.Println(string(encoded))

// Requires Insights preview access for the organization.
$report = $bird->email->competitive->brands->search(['q' => 'Everlane']);
var_dump($report->getData());

bird email competitive brands search <q>

curl -X GET "https://us1.platform.bird.com/v1/email/competitive/brands/search" \
  -H "Authorization: Bearer $TOKEN" \
  --url-query "q=everlane"

Reactie200

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