Documentos
Ctrl+K Pesquisar Alt+[Alt+] Guias
Obter chave da API

API · Marcas

Marcas e acompanhamento de marcas

Isso complementa o Referência da API. GET /api/v1/marcas is the API-key tracked-brands list (metered credits). Detail tabs and deep brand analytics use /api/marcas/* in the browser while you are logged in.

Nota sobre o caminho: Tracked brands over an API key: only GET /api/v1/marcas. GET /api/brands is the painel list for the logged-in session (same underlying data, not the metered JSON route for keys). Biblioteca de anúncios do Meta (GET /api/v1/adlibrary) is documented in Biblioteca de anúncios do Meta.


MCP tool (Brand tracker)

  • marcas_acompanhadas — same data as GET /api/v1/marcas (optional pesquisar, classificar, board_id).

Configuração: MCP. Parâmetros: MCP · Referência de ferramentas. Para pesquisar_anúncios_no_Facebook, consulte Biblioteca de anúncios do Meta.


Autenticação e medição compartilhadas (/api/v1/adlibrary, /api/v1/marcas)

GET /api/v1/marcas uses the same auth and metering path as /api/v1/adlibrary. Full parameter context for the ad library route lives in Biblioteca de anúncios do Meta.

  • Chave da API: Chave X-API, Autorização: ao portador, ou ?api_key= (ver Referência da API).
  • Sessão: Se o visitante já estiver conectado, as mesmas rotas podem ser executadas sem uma chave; o usuário ativo ainda deve passar pela verificação de acesso à API descrita abaixo.
  • Plano: A conta deve incluir Acesso à API. Caso contrário 403.
  • Créditos / limite de taxa: Créditos mensais de API e 60 solicitações por minuto por usuário. Quando esgotado, 429 com um erro JSON e opcional créditos objeto.

Quando você usa uma chave de API sem uma sessão de navegador ativa, o servidor ainda associa a chave à sua conta para essa solicitação, de modo que o comportamento seja idêntico ao do painel.


GET /api/v1/marcas — Tracked brands list (API key)

Returns the same tracked-brands list you see in the app’s Brand tracker, scoped to the API key owner.

Query parameters

Parâmetro Padrão Descrição
classificar date_added date_added, nome, new_ads, growth
pesquisar '' Case-insensitive match on brand name or page id
board_id If set, only brands on that saved board (must belong to the user)

Response

JSON array of brand rows (not wrapped in { success, data }). Each item includes fields such as id (Facebook page id), nome, logo_url, added_at, page_url, status, total_ads, active_ads_on_page, formats, new_ads_count, new_ads_change, and related summary fields (same shape as the in-app list).


Brand details (GET /api/brands/*) — session / logged-in

These routes require a logged-in browser session (except GET /api/brands/shared-board, which uses a token). They are não the metered API-key list — that is GET /api/v1/marcas only. Automating detail tabs means driving the app with session cookies, not the API key alone.

Brand identifier: Almost all detail endpoints take id = Facebook page_id (same as id in the brands list).


Track / untrack brands (session)

Yes — you can both track and remove brands in the Brand tracker, using session-authenticated routes:

Track a brand

POST /api/brands/follow

JSON body:

{ "url": "https://www.facebook.com/ads/library/?view_all_page_id=108897621643793" }

Notas:

  • Requires a logged-in session and plan capacity.
  • Devoluções success, plus brand, has_data, e details_url when accepted.

Remove a tracked brand

POST /api/brands/unfollow

JSON body:

{ "page_id": "108897621643793" }

Notas:

  • Removes the brand from your tracker.
  • Also removes that brand from your boards for the current user.
  • Devoluções success, amount, e max_allowed.

Count tracked brands

GET /api/brands/amount-tracked returns:

  • amount - number of brands currently tracked by the logged-in user.
  • max_allowed - plan cap for Brand tracker.

Date range filter (many detail tabs)

Query parameters map as follows:

período Significado
(absent) ou todos No date filter
ao vivo Last seen in the last 3 days (atualizado em field)
7d, 30d, 3m, 6m Ads with start date on or after the rolling cutoff (começou field)
custom Requires data_de e data_até as D-m-a

Used directly by GET /api/brands/ads. The same filter applies to other brand insight tabs (ad copies, headlines, hooks, personas, themes, …): pass the same período / data_de / data_até query params on those endpoints.

Example: paginated ads for one brand

GET /api/brands/ads?id={page_id}&page={n}

  • página: 0-based page index (12 ads per page).
  • Optional date filter: período, data_de, data_até as above.
  • Response: JSON array of processed ad objects.

Other detail endpoints — common query parameters

Parâmetro Where it applies
id Marca page_id on ads, ad-hooks, ad-copies, ad-headlines, personas, themes, angles, desires, emotions, awareness-stages, funnel-stages, usps, landing-pages, and similar get* methods.
página Ads list: 0-based, 12 ads/page. Many other tabs use 1-based pagination (typically 20 rows per page).
classificar, pesquisar Text / insight tabs; default Utilização or method-specific (see each handler).
período, data_de, data_até Any tab that supports the date filter (same semantics as the table above).
view=eu When view is eu, EU-specific field variants and search behavior apply.
GET /api/brands/ads-by-ids IDs — comma-separated ad ids.
GET /api/brands/search q — search string.
GET /api/brands/ads-launched min, máximo (date strings), metric: ads_launched (default), spend, alcance (spend/reach EU-oriented per code comments).
GET /api/brands/shared-board token, pesquisar, classificar — public share link; no login cookie required.
GET /api/brands/download-landing-screenshot url — target page URL to capture.

Brand-related routes are also summarized in the API reference.