Search brands to add to the watchlist
/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"{
"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. 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.
API-key calls require Insights preview access for your organization.
查询参数
qstringA brand name, or a sending domain to look up the brand behind it.
响应载荷
dataWatchable matches returned for this query. A capped search or an unresolved sending domain can omit a brand; an empty result does not establish that the panel has never observed it.
显示子属性
data.brand_iddata.nameThe brand's name.
data.sending_domainsThe domains this brand's figures would describe. Always one domain today, chosen as the one the panel sees the most of its mail from.