> For the complete documentation index, see [llms.txt](https://docs.airops.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.airops.com/docs/pt/programadores/api.md). # API Insights A API de Insights do AirOps: uma API de rastreamento de citações de AEO e IA com acesso programático à taxa de menções, share of voice, citações e desempenho de páginas, para painéis personalizados, ETL e relatórios. A API Insights é a API de otimização do motor de respostas (AEO) da AirOps e de acompanhamento de citações de IA, dando-lhe acesso programático aos mesmos dados que vê no seu painel Insights — taxas de menções, citações, share of voice, desempenho da página e muito mais. Use-a para criar painéis personalizados, automatizar relatórios ou enviar dados de AEO para o seu data warehouse juntamente com as suas outras métricas de marketing. Todos os endpoints do Insights ficam em `/public_api/brand_kits` e exigem um Brand Kit com AEO ativado. Para a configuração da autenticação, consulte a [Referência da API](https://docs.airops.com/api-reference). *** ## Modelo de Dados O Brand Kit é o recurso raiz. Todo o resto se liga a ele: | Recurso | O que contém | | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Análises** | Consultas flexíveis de métricas — taxa de menções, share of voice, taxa de citação, sentimento e muito mais — segmentadas por fornecedor, concorrente, tópico, país ou data | | **Páginas Web** | As suas páginas monitorizadas com citações de AEO, Google Search Console e métricas do GA4 combinadas | | **Prompts** | Perguntas de IA que estão a ser monitorizadas, com taxas de menções/citações e tendências | | **Citações** | URLs citadas nas respostas de IA, com pontuação de influência e sentimento | | **Concorrentes** | Domínios que está a monitorizar para análise competitiva | | **Tópicos** | Categorias que organizam os seus prompts | | **Personas** | Perfis de público usados para análise de prompts | *** ## Início rápido ### 1. Encontre o seu Brand Kit ```bash curl -X POST https://api.airops.com/public_api/brand_kits/list \\ -H "Authorization: Bearer YOUR_API_KEY" \\ -H "Content-Type: application/json" \\ -d '{ "filters": [{ "field": "aeo_enabled", "operator": "EQ", "value": true }] }' ``` A resposta inclui o seu Brand Kit `id` — use-o em todas as chamadas subsequentes. ### 2. Consultar a sua visibilidade de IA ```bash curl -X POST https://api.airops.com/public_api/brand_kits/{brand_kit_id}/analytics \\ -H "Authorization: Bearer YOUR_API_KEY" \\ -H "Content-Type: application/json" \\ -d '{ "metrics": ["mention_rate", "share_of_voice", "citation_rate"], "dimensions": ["date"], "grain": "weekly", "start_date": "2026-01-01", "end_date": "2026-02-18" }' ``` ### 3. Encontrar páginas que precisam de atenção ```bash curl -X POST https://api.airops.com/public_api/brand_kits/{brand_kit_id}/web_pages/list \\ -H "Authorization: Bearer YOUR_API_KEY" \\ -H "Content-Type: application/json" \\ -d '{ "smart_filter": "losing_ai_visibility", "per_page": 10, "sort": "-citations_count" }' ``` Com três chamadas, obtém: a tendência da sua visibilidade, a posição competitiva e as páginas que precisam de trabalho. *** ## Endpoints ### De que endpoint preciso? | Quero... | Use | | ----------------------------------------------------- | ------------------------------------ | | Obter as minhas métricas gerais de visibilidade de IA | Análises | | Comparar com concorrentes ao longo do tempo | Análises com `concorrente` dimensão | | Detalhar o desempenho por fornecedor de IA | Análises com `fornecedor` dimensão | | Encontrar páginas a perder citações ou classificações | Páginas Web com filtros inteligentes | | Obter dados de AEO + SEO + tráfego por página | Páginas Web | | Ver quais perguntas de IA mencionam a minha marca | Prompts | | Ver quais URLs estão a ser citadas | Citações | ### Análises `POST /public_api/brand_kits/{id}/analytics` O endpoint mais flexível. Escolha qualquer combinação de métricas e dimensões para construir a consulta exata de que precisa. **Métricas:** | Métrica | Descrição | | -------------------- | --------------------------------------------------------- | | `mention_rate` | % das respostas de IA que mencionam a sua marca (0-100) | | `share_of_voice` | As suas menções / (as suas + as dos concorrentes) (0-100) | | `citation_rate` | % das respostas de IA que citam as suas páginas (0-100) | | `citation_share` | As suas citações / total de citações (0-100) | | `citation_count` | Número absoluto de citações | | `sentiment_score` | Sentimento das menções à marca (0-100) | | `average_position` | Posição média nas listas de respostas de IA | | `answer_count` | Total de respostas de IA analisadas | | `first_mention_rate` | % das respostas em que é mencionado primeiro (0-100) | **Dimensões** (até 3 por consulta): `date`, `fornecedor`, `topic`, `country`, `persona`, `domain`, `concorrente`, `domain_category` **Granularidade temporal:** `diário` (máx. 120 dias), `semanal` (máx. 180 dias), `mensal` (máx. 365 dias), `total` (máx. 365 dias) **Filtros:** `providers`, `topics`, `countries`, `personas`, `brand_mentioned` **Limites:** Máximo de 1.000 linhas por consulta. Predefinição: 100. ### Páginas Web `POST /public_api/brand_kits/{id}/web_pages/list` As suas páginas monitorizadas combinam dados de citação, pesquisa, tráfego e Agent Analytics numa única resposta: | Fonte | Métricas | | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | **AEO** | `citations_count`, `citation_rate`, `prompts_count` | | **Google Search Console** | `cliques`, `impressões`, `CTR`, `posição` | | **Google Analytics 4** | `tráfego`, `sessões`, `envolvimento`, `envolvimento médio da sessão` | | **Agent Analytics** | `navegação do utilizador` (Visitas de Agente de IA), `treino de IA` (Rastreios de treino), `pesquisa de IA` (Rastreios de pesquisa na Web) | Os campos do Agent Analytics são contagens filtráveis e ordenáveis para o intervalo de datas selecionado. Ligue primeiro o Agent Analytics para recolher estes dados. Estes campos não incluem variantes de variação período a período. `total_crawls` não é um campo deste endpoint; use o endpoint de Agent Analytics abaixo para esse cálculo. Os espaços de trabalho do plano gratuito recebem **402 Payment Required** do endpoint Web Pages. **Filtros inteligentes** destacam oportunidades comuns: | Filtro | O que encontra | | ----------------------- | ----------------------------------------------- | | `almost_page_one` | Páginas classificadas entre #10 e #20 | | `losing_clicks` | Clques em declínio com classificações estáveis | | `rankings_slipping` | Posição na SERP em declínio ao longo de 90 dias | | `losing_ai_visibility` | Páginas a perder citações de IA | | `citation_rate_decline` | Perda de autoridade de IA apesar de SEO estável | Mais de 26 campos filtráveis com operadores: `EQ`, `NEQ`, `GT`, `LT`, `GEQ`, `LEQ`, `CONTAINS`, `STARTS_WITH`, `IN` ### Agent Analytics `POST /public_api/brand_kits/{id}/agent_analytics/list` Devolve contagens diárias de pedidos para as páginas monitorizadas do Brand Kit depois de ligar o Agent Analytics. Cada linha contém [ligar o Agent Analytics](/docs/pt/insights/onsite/traffic.md). Cada linha contém `date`, `plataforma`, `tipo de rastreio`, e `contagem`. As linhas sem pedidos são omitidas. Forneça `start_date` como no `end_date` para escolher um período. Pode filtrar por `plataforma`, `tipo de rastreio`, ou um `web_page_id`, e ordenar por `date` ou `contagem` (`-count` para que os maiores apareçam primeiro). A paginação predefinida é de 25 linhas e suporta até 100 por página. Leia todas as páginas antes de calcular totais. | Resultado | Cálculo | | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | Agent Analytics **Total de rastreios** | Soma `pesquisa de IA` como no `treino de IA` para os motores monitorizados. | | **Visitas do Agente de IA** | Soma `navegação do utilizador` para os motores monitorizados. | | **Motor de rastreio principal** | O motor monitorizado com o maior total combinado `pesquisa de IA` como no `treino de IA` contagem. | | **Distribuição por tipo de rastreio** | Cada um de `pesquisa de IA` como no `treino de IA` como percentagem do total combinado para os motores monitorizados. | | **Distribuição por motor** | Agrupe por motor monitorizado e some os rastreios de treino, os rastreios de pesquisa na Web, o respetivo total combinado e as Visitas do Agente de IA. | | **Atividade de rastreio vs. visitas do agente de IA** | Agrupe por data e tipo de rastreio em todas as plataformas devolvidas, incluindo `outras` requisições. | | **Visitas do Agente de IA ao longo do tempo** | Agrupar `navegação do utilizador` por data e motor monitorizado. | Os motores monitorizados para estes cálculos são `chat_gpt`, `perplexity`, `gemini`, `google_ai_mode`, e `claude`. A resposta também inclui outras plataformas, como rastreadores genéricos de pesquisa. Para corresponder à **Páginas** da tabela **Total de rastreios** de uma página, filtre pelo seu `web_page_id` e some todas as linhas, incluindo todas as plataformas e tipos de rastreio. Isto difere do total de rastreios apenas de IA no resumo do Agent Analytics. {% hint style="info" %} O endpoint diário segue a fronteira de data do separador Agent Analytics: um pedido exatamente à meia-noite após `end_date` pode aparecer como uma linha datada do dia seguinte. Exclua as linhas datadas após `end_date` ao corresponder à tabela Pages. {% endhint %} ### Prompts `POST /public_api/brand_kits/{id}/prompts/list` · `GET /public_api/brand_kits/{id}/prompts/{id}` Perguntas de IA monitorizadas para a sua marca. Cada prompt inclui `mention_rate`, `citation_rate`, e tendências período a período (`mention_rate_trend`, `citation_rate_trend`). Filtrar por `texto`, `brand_mentioned`, `topic_id`, `prompt_volume`, `mention_rate`, `citation_rate`. Delimite as métricas a fornecedores, países ou personas específicos usando filtros de contexto. ### Intenção da resposta As respostas de lista e de detalhe expõem o `intent_stage`: `consciência`, `consideração`, `avaliação`, ou `compra`. É `null` quando a classificação não está disponível. O mesmo campo está disponível através das ferramentas de resposta MCP. ### Citações `POST /public_api/brand_kits/{id}/citations/list` · `POST /public_api/brand_kits/{id}/citations/show` URLs citadas nas respostas de IA, cada uma pontuada com um `influence_score` (0-100) que tem em conta a autoridade do domínio, a frequência de citação e a relevância. Inclui `brand_sentiment` (positivo/neutro/negativo) e `domain_category`. Ordenar por `citation_count`, `citation_share`, `citation_rate`, ou `influence_score`. Para citações e domínios, `prompt_type` com `EQUALS` e valor `marca` ou `categoria` descreve o prompt. `brand_mentioned` com `EQ` e valor `true` ou `false` descreve se a página que cita menciona a sua marca. Estes filtros podem ser combinados: ```json { "filters": [ { "field": "prompt_type", "operator": "EQUALS", "value": "category" }, { "field": "brand_mentioned", "operator": "EQ", "value": true } ] } ``` O anterior `brand_mentioned EQUALS brand/category` como no `brand_referenced EQ true/false` continuam a ser aceites. Os novos filtros explícitos têm precedência se ambas as formas estiverem presentes. No endpoint Prompts, `brand_mentioned EQ true/false` continua a descrever o texto do prompt. As respostas da lista e de detalhe de citações incluem um `social` campo quando existem metadados sociais suportados. Identifica a plataforma e contém `conteúdo` como no `conta` objetos com metadados, métricas e estado de sincronização. `social` é `null` quando não existe nenhum registo social suportado; `social.account` pode ser `null` mesmo quando o conteúdo está presente. Os metadados podem estar incompletos enquanto a recolha está pendente ou após uma recolha falhada. Os metadados de conteúdo do YouTube também incluem `duration_seconds`, `format`, e `sponsorship_status`. A duração pode ser `null`; o formato e o estado de patrocínio usam `desconhecido` quando a informação não está disponível. ### Anúncios observados `POST /public_api/aeo/brand_kits/{id}/ads/list` · `POST /public_api/aeo/brand_kits/{id}/ads/show` Consulte os anúncios do ChatGPT e do Google AI Mode que a AirOps observa para os prompts monitorizados do Brand Kit. Estes endpoints usam os mesmos dados de anúncios observados que [Biblioteca de anúncios](/docs/pt/insights/ads.md#ad-library) e não requerem uma ligação a uma conta ChatGPT Ads. Requerem acesso aos dados de Ads do Brand Kit. | Endpoint | Devolve | | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Lista** | Uma linha por fornecedor e criativo observado, detalhes do anunciante, título e corpo, aparições, respostas distintas, prompts, frequência e histórico de observação | | **Mostrar** | Detalhes de um criativo específico do fornecedor, imagem e URL de destino, anunciante e histórico de observação | Passe o `observed_creative_id` como `id` e o seu `fornecedor` como um único elemento `providers` matriz para o endpoint de exibição. Isso identifica um criativo observado nessa plataforma, não um recurso na sua conta de anúncios conectada. O mesmo criativo pode ter linhas de lista separadas para plataformas diferentes. As listas incluem ambos os provedores suportados por padrão. Use `providers: ["chat_gpt"]` ou `providers: ["google_ai_mode"]` para selecionar um. As solicitações de exibição usam ChatGPT por padrão quando omitido e exigem exatamente um provedor quando fornecido. Os filtros da lista incluem `topic_id`, `prompt_id`, e `prompt_type` (`EQUALS` com `marca` ou `categoria`). O antigo `brand_mentioned` alias prompt-type ainda é aceito. Delimite as solicitações com `start_date`, `end_date`, `providers`, `countries`, `personas`, e `tags`. A lista oferece suporte a paginação e seleção de campos. `appearances` conta ocorrências do anúncio; `answers` conta respostas distintas coletadas que contêm o anúncio. `frequency` é a porcentagem de respostas rastreadas no escopo que o contêm. `first_seen` como no `last_seen` abrangem o histórico de observação do anúncio, e `days_active` é o intervalo inclusivo entre eles. O endpoint de exibição não retorna as métricas de janela, aparição, resposta, prompt ou frequência da lista. Essas observações não estabelecem cobertura total de mercado, investimento do anunciante ou intenção de segmentação. As ferramentas MCP equivalentes são [list\_aeo\_ads e get\_aeo\_ad](/docs/pt/programadores/tools.md#list_aeo_ads). ### Concorrentes, Tópicos, Personas `POST /public_api/brand_kits/{id}/competitors/list` · `GET .../competitors/{id}` `POST /public_api/brand_kits/{id}/topics/list` · `GET .../topics/{id}` `POST /public_api/brand_kits/{id}/personas/list` · `GET .../personas/{id}` Dados de referência para a configuração do seu Brand Kit. Use estes IDs ao filtrar outros endpoints. *** ## Padrões comuns ### Paginação Todos os endpoints de lista usam paginação baseada em offset com no máximo 100 itens por página. ```json { "page": 1, "per_page": 100 } ``` As respostas incluem `meta.total_count` como no `meta.total_pages`. Faça loop até `page >= total_pages`. ### Filtragem Passe uma `filters` matriz no corpo da solicitação: ```json { "filters": [ { "field": "citation_rate", "operator": "GT", "value": 5 }, { "field": "brand_mentioned", "operator": "EQ", "value": true } ] } ``` | Digite | Operadores | | -------- | ------------------------------------- | | Texto | `EQUALS`, `CONTAINS`, `STARTS_WITH` | | Numérico | `EQ`, `NEQ`, `GT`, `LT`, `GEQ`, `LEQ` | | Conjunto | `IN` | ### Ordenação Passe uma `sort` string. Prefixe com `-` para ordem decrescente: ```json { "sort": "-citation_rate" } ``` ### Seleção de campos Passe uma `fields` matriz para limitar os campos retornados: ```json { "fields": ["url", "citations_count", "clicks", "position"] } ``` ### Intervalos de datas Os endpoints de métricas aceitam `start_date` como no `end_date` em `YYYY-MM-DD` como formato. O padrão é os últimos 30 dias se omitido. * `end_date` deve ser anterior a hoje * As métricas de GSC e GA4 têm um atraso de 4 dias ### Disponibilidade de dados Toda resposta de métrica inclui um objeto `data_availability` objeto: ```json { "data_availability": { "earliest_data_date": "2025-10-15", "latest_data_date": "2026-02-18", "requested_period_has_data": true } } ``` Verifique `requested_period_has_data` antes de processar os resultados. *** ## Provedores de IA suportados Use estes valores no `providers` filtro: | Valor | Plataforma | | -------------------- | ------------------ | | `chat_gpt` | ChatGPT | | `gemini` | Google Gemini | | `perplexity` | Perplexity | | `google_ai_mode` | Google AI Mode | | `google_ai_overview` | Google AI Overview | | `claude` | Claude | O Claude está disponível por padrão em workspaces Enterprise. Cada resposta do Claude usa quatro unidades de faturamento: quatro tarefas em um workspace com tarefas combinadas ou quatro créditos de resposta em um workspace legada. Veja [uso e faturamento de respostas AEO](/docs/pt/o-seu-espaco-de-trabalho/settings/billing.md#aeo-answers-usage-and-billing). *** ## Países suportados A AirOps aceita estes 49 códigos de região. Passe códigos ISO 3166-1 alfa-2 no `countries` filtro: `AE` `AR` `AT` `AU` `BE` `BR` `CA` `CH` `CL` `CN` `CO` `CZ` `DE` `DK` `ES` `FI` `FR` `GB` `GR` `HR` `HU` `ID` `IE` `IL` `IN` `IS` `IT` `JP` `KE` `KR` `MX` `MY` `NG` `NL` `NO` `NZ` `PE` `PH` `PL` `PT` `SA` `SE` `SG` `TH` `TR` `TW` `US` `VN` `ZA` A cobertura da plataforma varia por região. Uma região que aparece nesta lista não garante que todos os provedores de IA coletem respostas lá. Por exemplo, o Quênia é compatível com ChatGPT, Google AI Overview, Google AI Mode e Claude; outros provedores podem não estar disponíveis. *** ## Erros | Status | Significado | | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- | | **400** | Filtro, operador ou campo de ordenação inválido. Verifique `validation_errors` na resposta. | | **401** | Chave de API ausente ou inválida. | | **402** | O endpoint requer um workspace pago; solicitações de Web Pages de workspaces Free retornam este status. | | **404** | O Brand Kit não existe ou você não tem acesso. | | **412** | A AEO não está configurada para este Brand Kit. | | **422** | Específico de Analytics: `end_date` é hoje ou posterior, o intervalo de datas excede o limite de granularidade ou há mais de 3 dimensões. | *** ## Casos de utilização ### ETL e exportação de dados A AEO é uma nova categoria de dados que a maioria das pilhas de marketing ainda não tem. A API permite carregá-la em seu data warehouse junto com dados de SEO, pagos e de análise da web para análises multicanal. **O que exportar:** | Tabela | Endpoint de origem | Estratégia de sincronização | | ------------------------ | ---------------------------------------- | -------------------------------------------- | | Métricas de visibilidade | Analytics (dimensões: data, provedor) | Incremental diário — anexar a linha de ontem | | Tendências competitivas | Analytics (dimensões: data, concorrente) | Incremental semanal | | Desempenho da página | Páginas Web | Captura diária — pagine todas as páginas | | Inventário de citações | Citações | Captura semanal — pagine todas as citações | | Paisagem de prompts | Prompts | Captura semanal — pagine todos os prompts | **Opções de integração:** * **Airflow / Dagster / Prefect** — Adicione um DAG que chama a API, grava JSON no S3/GCS e carrega via `COPY INTO` * **Airbyte / Fivetran** — Use o conector genérico de origem da API HTTP com método POST e paginação baseada em offset * **Snowflake Snowpark** — Chame a API diretamente de uma stored procedure e agende com Snowflake Tasks * **AWS Lambda + Snowpipe** — Função sem servidor em um cron grava no S3, o Snowpipe ingere automaticamente **Dicas de pipeline:** * `end_date` deve ser uma data passada — a API só fornece dados finalizados, então defina como ontem ou antes. Solicitações com a data de hoje ou uma data futura retornarão um `422` erro. * As métricas de GSC e GA4 têm um **atraso de 4 dias** — os dados dos 3 dias mais recentes podem ainda não estar disponíveis * Use `per_page=100` (o máximo) para minimizar as chamadas ao paginar * Verifique `meta.data_availability.requested_period_has_data` para detectar intervalos de datas vazios antes de processar * O endpoint de analytics limita a **1.000 linhas** por consulta — para intervalos longos com dimensões de alta cardinalidade, divida em janelas com base no limite de granularidade (120 dias para diário, 180 para semanal, 365 para mensal) O endpoint de Web Pages é especialmente valioso para ETL porque combina AEO + GSC + GA4 em uma única resposta — poupando você de juntar três fontes de dados separadas. ### Looker Studio Fornecemos um conector comunitário do Looker Studio pronto para implantar que visualiza seus dados AEO diretamente — sem ETL, data warehouse ou programação necessários. **O que você recebe:** Três fontes de dados em um conector: | Fonte de dados | O que mostra | | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | **Análises de visibilidade de IA** | Taxa de menções, participação de voz, taxa de citação, sentimento e mais — segmentados por data, provedor, concorrente, tópico ou país | | **Desempenho da página** | Métricas de AEO + Google Search Console + GA4 pré-combinadas por URL em uma única fonte de dados | | **Citações** | URLs de origem citadas com informações de domínio, sentimento, pontuação de influência e autoridade de domínio | #### Obtendo sua chave de API 1. Faça login em [AirOps](https://app.airops.com) e vá para **Definições da Área de trabalho** 2. Encontre a **Chave da API** seção 3. Copie sua chave de API — ou clique em **Regenerar** se precisar de uma nova A chave se autentica como um token Bearer. Mantenha-a confidencial e nunca a exponha em código do lado do cliente. > **Nota:** Regenerar sua chave de API invalida imediatamente a antiga. Se você tiver integrações existentes usando a chave, atualize-as antes de regenerar. #### Conectando ao Looker Studio 1. Abra o [AirOps AEO Connector](https://lookerstudio.google.com/datasources/create?connectorId=AKfycbwR2EmDc6nXQkCLQNnn8EvUk_Z30Maf8wWD1sK3T13Zoe9LeeEQy3MtK6uzi_sU_1za) 2. **Autorizar** o conector quando solicitado pelo Google. Você pode ver um aviso "O Google não verificou este aplicativo" — clique em **Avançado** → **Ir para o AirOps AEO Connector** para continuar. Isso aparece apenas uma vez. 3. Insira sua **chave de API da AirOps** quando solicitado 4. Preencha a configuração: * **Brand Kit ID** — seu Brand Kit ID numérico (visível na URL do painel da AirOps, por exemplo, `app.airops.com/brand_kits/12345`) * **Fonte de dados** — escolha uma das três opções: Análises de visibilidade de IA, Desempenho da página ou Citações 5. Clique em **Conectar** — o Looker Studio obtém o esquema automaticamente 6. Clique em **Criar relatório** para começar a criar > **Dica:** Adicione o conector **três vezes** (uma vez por fonte de dados) para obter analytics, desempenho da página e citações em um único relatório. Cada fonte de dados se torna uma fonte independente que você pode usar em qualquer gráfico. #### Exemplos de gráficos * **Série temporal** — Taxa de menções ao longo do tempo (Analytics: Date + Mention Rate) * **Gráfico de barras** — Participação de voz por provedor de IA (Analytics: AI Provider + Share of Voice) * **Comparação de concorrentes** — Barra agrupada da Taxa de menções por Concorrente * **Tabela das principais páginas** — URL com Citações, Cliques do GSC e Tráfego do GA4 lado a lado (Pages) * **Gráfico de dispersão** — Citações vs. Cliques do GSC para encontrar páginas que vencem tanto em AEO quanto em SEO (Pages) * **Principais domínios citantes** — Gráfico de barras de Domínio por Citações (Citations) * **Detalhamento do sentimento** — Gráfico de pizza do Sentimento da marca por contagem de citações (Citations) #### Campos disponíveis **Análises de visibilidade de IA:** | Dimensões | Métricas | | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Data, Provedor de IA, Concorrente, Tópico, País | Taxa de menções, Participação de voz, Taxa de citação, Citações, Sentimento, Posição média, Taxa da primeira menção, Respostas | **Desempenho da página:** | Dimensões | Métricas | | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | | URL, Pasta | Citações, Taxa de citação, Prompts, Cliques do GSC, Impressões do GSC, CTR do GSC, Posição do GSC, Tráfego do GA4, Sessões do GA4, Engajamento do GA4 | **Citações:** | Dimensões | Métricas | | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | URL, Domínio, Categoria do domínio, Tipo de página, Marca mencionada, Sentimento da marca | Citações, participação de citações, taxa de citação, pontuação de influência, autoridade de domínio | #### Sugestão de layout do painel Uma visão executiva de uma página pode incluir: * **Linha superior** — widgets de scorecard para Taxa de menções, Participação de voz, Taxa de citação, Total de citações * **Meio à esquerda** — Taxa de menções ao longo do tempo (gráfico de linha) * **Meio à direita** — Participação de voz por provedor de IA (gráfico de barras) * **Inferior esquerdo** — tabela das principais páginas (URL, Citações, Cliques do GSC, Tráfego do GA4) * **Inferior direito** — Principais domínios citantes (gráfico de barras) Adicione uma **Widget de controle de intervalo de datas** adicionar ao relatório — as três fontes de dados o respeitam automaticamente. Os dados de hoje são excluídos, pois estão incompletos. #### Limitações * A API de Analytics permite um máximo de **3 dimensões** por consulta * Desempenho da página e Citações retornam as **500 primeiras linhas** por carregamento * Este é um Conector Comunitário — cada usuário deve autorizá-lo no primeiro uso ### Painéis personalizados Crie painéis internos no Retool, Metabase ou Grafana. O endpoint de analytics é flexível o suficiente para alimentar um painel inteiro a partir de um único endpoint — basta alterar as dimensões. ### Relatórios automatizados Agende um script para coletar métricas semanais e enviar um resumo no Slack ou um resumo por e-mail para sua equipe. O endpoint de analytics com `concorrente` como no `date` dimensões oferece a você um relatório competitivo completo em uma única chamada. ### Alertas Use filtros inteligentes em uma programação para detectar quando as páginas começam a perder visibilidade de IA ou quando os rankings caem. Dispare alertas no Slack, PagerDuty ou por e-mail quando o `losing_ai_visibility` filtro retornar resultados. ### Priorização de conteúdo Combine `citation_rate`, `influence_score`, e filtros inteligentes para classificar programaticamente quais páginas otimizar primeiro. Insira a lista priorizada no seu calendário de conteúdo ou ferramenta de gerenciamento de projetos. *** Para ver as especificações completas dos endpoints, incluindo os esquemas de solicitação/resposta, consulte o [Referência da API](https://docs.airops.com/api-reference/api-reference/brand-kits). --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.airops.com/docs/pt/programadores/api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.