v1

latestOpenAPI 3.0.32026-07-24205887.6 KB
Brand Library

Search brand library

Search Atria's global brand library by name. Results span all ingested sources (Meta and TikTok ad libraries), ordered by ad volume (ad_num) descending.

Each result's id carries an origin prefix: m* for Meta-origin brands and t* for TikTok-origin. Use that id directly when calling GET /open/v1/brand-library/{brand_id} or GET /open/v1/brand-library/{brand_id}/ads.

Returns: code=0 success; code=40001 invalid query parameters.

get/open/v1/brand-library/search

Query parameters

keywordstring

Brand name keyword. Case-insensitive substring match.

Brand name keyword. Case-insensitive substring match.

platformOpenBrandSearchPlatform[]

Restrict by source ad library. Repeatable. Allowed values: meta_ad_library, tiktok_ad_library — these match the ad_library field on each returned brand.

Restrict by source ad library. Repeatable. Allowed values: meta_ad_library, tiktok_ad_library — these match the ad_library field on each returned brand.

industrystring[]

Filter by industry tag. Repeatable. Free-form tags from the brand's industries (e.g. apparel, sportswear, health/beauty).

Filter by industry tag. Repeatable. Free-form tags from the brand's industries (e.g. apparel, sportswear, health/beauty).

pageinteger

1-based page number (default 1).

1-based page number (default 1).

page_sizeinteger

Items per page (1-100, default 20).

Items per page (1-100, default 20).

Response

Successful Response

codeinteger
messagestring