API e exportações
Gere chaves só de leitura, acompanhe o uso do mês, agende exportações em CSV e ligue os dados ao Looker Studio e ao Power BI em Configurações › API e integrações.
Neste artigo · 10 seções
A seção API e integrações leva os dados do Relator para fora: painéis no Looker Studio e no Power BI, planilhas e sistemas próprios. Tudo é somente leitura: nenhuma chave cria, edita ou publica nada nas contas dos clientes.
Antes de começar
- Onde fica: Configurações › grupo Agência › API e integrações. Na conta própria, Configurações › API e integrações, no grupo Sua conta.
- Quem usa: a equipe da agência (ou o dono da conta própria). Dono e Admin criam e revogam chaves; Membro só vê. Pessoas do cliente não têm acesso a esta seção.
- Plano: a API vem incluída no Scale e no Enterprise. No Starter e no Pro, ela é liberada pelo complemento API e MCP. Sem o recurso, a seção mostra uma tela de exemplo e o caminho para liberar.
O que tem em cada aba
Chaves de API
- Para que serve
- Criar, listar e revogar chaves. Mostra também a URL da API, com o botão Copiar.
Exportações agendadas
- Para que serve
- Mandar um CSV por e-mail ou para o Google Drive todo dia, toda semana ou todo mês, sem chave.
Looker Studio e Power BI
- Para que serve
- O passo a passo de cada ferramenta e a URL do feed do Power BI, montada por seletores.
Uso
- Para que serve
- Quantas requisições a API recebeu no mês, contra o limite do plano.
| Aba | Para que serve |
|---|---|
| Chaves de API | Criar, listar e revogar chaves. Mostra também a URL da API, com o botão Copiar. |
| Exportações agendadas | Mandar um CSV por e-mail ou para o Google Drive todo dia, toda semana ou todo mês, sem chave. |
| Looker Studio e Power BI | O passo a passo de cada ferramenta e a URL do feed do Power BI, montada por seletores. |
| Uso | Quantas requisições a API recebeu no mês, contra o limite do plano. |
Criar uma chave
- 1Passo 1
Abra API e integrações
Clique em Configurações na barra lateral e, no grupo Agência, em API e integrações. Clique em Nova chave.
Tela ilustrativaAgência Farol/API e integraçõesPerguntar ao RelatorAIPT
API e integraçõesSomente leitura · 200.000 requisições por mêsChaves de APIExportações agendadasLooker Studio e Power BIUsoChaves de acessoNome Acesso Clientes Último uso Looker Studio · Korra Leitura 1 cliente há 2 horas Power BI · todos Leitura + metas Todos (6) Nunca usada - 1Nova chave abre a criação em 3 passos.
- 2Cada chave mostra o que lê, de quais clientes e quando foi usada pela última vez. Revogar fica na linha.
- 2Passo 2
Diga para que é
Escolha a finalidade: Looker Studio, Power BI, Planilha ou Sistema próprio. Clique em Continuar.
- 3Passo 3
Escolha o que a chave lê
Depois clique em Criar chave.
- O que pode ler: Métricas de mídia (Meta Ads, Google Ads, GA4), CRM e receita (HubSpot, RD Station), Metas e SEO (Search Console).
- Clientes: escolha na lista com busca ou marque Todos os clientes (inclui os novos).
- Validade: 30 dias, 1 ano ou Sem validade.
- Nome: o RelatorAI sugere um nome a partir da finalidade e dos clientes. Dá para editar.
- 4Passo 4
Copie a chave
A janela Chave criada mostra a chave inteira uma única vez. Clique em Copiar chave e guarde num lugar seguro antes de Concluir.
Usar a chave
Looker Studio
- Como conectar
- Crie a chave com a finalidade Looker Studio, abra o conector do Relator no Looker Studio, autorize e cole a chave quando ele pedir. Se o botão Abrir conector do Looker Studio estiver desligado com o aviso Conector em publicação, use o Power BI, o CSV ou as exportações agendadas até o conector sair.
Power BI
- Como conectar
- Na aba Looker Studio e Power BI, escolha o cliente, a fonte e o formato e copie a URL do feed (últimos 30 dias, uma linha por dia). No Power BI, use Obter dados › OData (ou Web), cole a URL e escolha autenticação Básica: qualquer usuário e a chave como senha.
Excel e planilhas
- Como conectar
- Use a mesma URL do feed no formato CSV para Excel e planilhas, ou agende o CSV na aba Exportações agendadas.
Sistema próprio
- Como conectar
- Chame a URL da API mandando a chave no cabeçalho
Authorization: Bearer. Para baixar uma tabela, use/metricscomformat=csv.
| Ferramenta | Como conectar |
|---|---|
| Looker Studio | Crie a chave com a finalidade Looker Studio, abra o conector do Relator no Looker Studio, autorize e cole a chave quando ele pedir. Se o botão Abrir conector do Looker Studio estiver desligado com o aviso Conector em publicação, use o Power BI, o CSV ou as exportações agendadas até o conector sair. |
| Power BI | Na aba Looker Studio e Power BI, escolha o cliente, a fonte e o formato e copie a URL do feed (últimos 30 dias, uma linha por dia). No Power BI, use Obter dados › OData (ou Web), cole a URL e escolha autenticação Básica: qualquer usuário e a chave como senha. |
| Excel e planilhas | Use a mesma URL do feed no formato CSV para Excel e planilhas, ou agende o CSV na aba Exportações agendadas. |
| Sistema próprio | Chame a URL da API mandando a chave no cabeçalho Authorization: Bearer. Para baixar uma tabela, use /metrics com format=csv. |
Limites e uso
- Cada plano tem um teto mensal de requisições, mostrado no topo da seção e na aba Uso: 50.000 por mês no Starter e no Pro (com o complemento) e 200.000 no Scale. No Enterprise, o limite é de contrato.
- A aba Uso mostra o total do mês, a data em que renova e a projeção no ritmo atual.
- Ao passar de 90% do limite, aparece um aviso no topo da seção e os donos da agência recebem um e-mail.
- Acima do limite, a API responde com erro 429 até a renovação. As exportações agendadas não usam chave.
- Chaves sem uso há 90 dias expiram sozinhas, além da validade escolhida.
- Uma chave para de funcionar se a pessoa que a criou sair da agência ou deixar de ser Dono ou Admin.
Exportações agendadas
- 1Passo 1
Crie a exportação
Na aba Exportações agendadas, clique em Nova exportação.
- 2Passo 2
Escolha destino e conteúdo
- Destino: E-mail (CSV), escolhendo em Quem recebe as pessoas da agência, ou Google Drive. Para o Drive, conecte a conta antes em Conectar Google Drive; o Relator só enxerga a pasta que ele mesmo cria.
- Fonte: Meta Ads, Google Ads, Google Analytics 4, Search Console, HubSpot ou RD Station.
- Linhas: por dia ou por campanha.
- Clientes e Nome, como na chave.
- 3Passo 3
Defina a frequência e agende
Escolha Todo dia, Toda semana (com o dia da semana) ou Todo mês (com o dia do mês) e o Horário, no fuso mostrado na tela. Clique em Agendar exportação.
- Por e-mail, chega um link Baixar o CSV. O link vale 7 dias e exige login no Relator com a mesma agência.
- Link vencido, de outra conta ou de exportação apagada abre a tela Este link de download não vale mais. A próxima entrega manda um link novo.
- Quando um envio falha, a linha mostra Falhou com o motivo e o botão Tentar de novo. Se o Drive perdeu o acesso, use Reconectar Google Drive.
- Excluir para os próximos envios. Os arquivos já enviados continuam onde estão.
Revogar uma chave
Na aba Chaves de API, clique em Revogar na linha da chave e confirme. O acesso para na próxima requisição e os painéis que usam a chave deixam de atualizar. Revogue sempre que alguém que conhece a chave sair da agência ou quando a chave aparecer num lugar que não devia.
E os webhooks?
O Relator ainda não envia webhooks. Em Configurações › Notificações, o Webhook assinado aparece em Próximos canais, marcado como Em breve. Para ser avisado de problemas, use os alertas e as notificações por e-mail.
Disponibilidade por plano
| Recurso | Starter | Pro | Scale | Enterprise |
|---|---|---|---|---|
| Preço mensal (cartão) | R$ 59/mês | R$ 199/mês | R$ 499/mês | A partir de R$ 1.499/mês |
| Anual no cartão (12 meses pelo preço de 10) | R$ 590 | R$ 1.990 | R$ 4.990 | A partir de R$ 1.499/mês |
| Espaços de cliente | 1 | 5 | 15 | Sob contrato |
| Fontes de dados conectadas | 5 | 25 | 75 | Sob contrato |
| Pessoas da equipe | 2 | 5 | 15 | Sob contrato |
| Atualização completa dos dados | 1 vez por dia | A cada 6 horas | A cada hora | A cada 15 minutos |
| Mensagens do RelatorAI por mês | 100 | 300 | 1.000 | Sob contrato |
| Histórico disponível | 12 meses | 24 meses | 36 meses | Sob contrato |
| Dashboards personalizados | Não incluído | Incluído | Incluído | Incluído |
| Relatórios agendados | Não incluído | Incluído | Incluído | Incluído |
| Modelos de relatório | Não incluído | Incluído | Incluído | Incluído |
| CRM e ROAS real | Incluído | Incluído | Incluído | Incluído |
| Metas e alertas | Não incluído | Incluído | Incluído | Incluído |
| Marca branca no portal e nos relatórios | Não incluído | Incluído | Incluído | Incluído |
| Acesso à API | Não incluído | Não incluído | Incluído | Incluído |
| Edição em lote de campanhas | Não incluído | Não incluído | Incluído | Incluído |
| Suporte prioritário | Não incluído | Não incluído | Incluído | Incluído |
| Assistentes de IA (MCP) | Não incluído | Não incluído | Incluído | Incluído |
| Gerenciador de campanhas | Não incluído | Não incluído | Incluído | Incluído |
| Gerente de conta dedicado | Não incluído | Não incluído | Não incluído | Incluído |
| SSO (login único) | Não incluído | Não incluído | Não incluído | Não incluído |
| Add-on | Preço mensal |
|---|---|
| Espaço de cliente extra | R$ 29/mês |
| Pessoa extra na equipe | R$ 15/mês |
| Gerenciador de campanhas (Meta Ads e Google Ads) | R$ 99/mês |
| API e MCP | R$ 49/mês |
| Atualização de hora em hora | R$ 79/mês |
| Pacote de 200 mensagens do RelatorAI | R$ 49 compra única |
Problemas comuns
- Não vejo Nova chave. Seu papel é Membro. Peça a um Dono ou Admin da agência.
- A seção mostra “Disponível a partir do” um plano. O plano não inclui a API. Contrate o complemento API e MCP ou mude para o Scale. Veja Complementos.
- O painel parou de atualizar. A chave foi revogada, expirou (validade ou 90 dias sem uso) ou quem a criou saiu da agência. Crie uma chave nova e troque no painel.
- Erro 429. O limite do mês acabou. A aba Uso mostra quando renova.
- A URL do feed não aparece. Nenhum cliente tem fonte conectada. Conecte uma fonte no cliente primeiro.
Perguntas frequentes
A chave consegue alterar campanhas ou dados?
Não. Toda chave é somente leitura.
Posso dar uma chave só com os dados de um cliente?
Pode. Ao criar, escolha só aquele cliente em Clientes. Um cliente fora da lista responde como se não existisse.
Preciso de chave para receber o CSV toda semana?
Não. As exportações agendadas mandam o CSV por e-mail ou para o Google Drive sem chave.
Posso conectar o Relator ao Zapier ou ao Make?
Não há integração pronta com essas ferramentas. Elas podem chamar a API com a chave no cabeçalho Authorization: Bearer, como qualquer sistema próprio.
E para perguntar no Claude ou no ChatGPT?
Use os assistentes de IA (MCP), liberados pelo mesmo complemento. Veja Assistentes de IA (MCP).
Leia também
- RelatorAIAssistentes de IA (MCP): o Relator no Claude e no ChatGPTPergunte sobre os clientes no Claude ou no ChatGPT e receba os números do Relator. Veja o que o assistente consulta, como conectar, os limites e como revogar o acesso.
- Planos e cobrançaComplementos (add-ons)Workspace e assento extra, gerenciador de campanhas, API e MCP, atualização de hora em hora e pacote de mensagens do RelatorAI: preço, em quais planos e como são cobrados.
- Planos e cobrançaPlanos e preçosStarter, Pro e Scale, a tabela única para negócios e agências: o que cada limite significa, quais recursos cada plano libera, os complementos e como escolher.
- RelatóriosAgendar o envio automáticoDefina frequência, dia, horário, fuso e destinatários para o relatório sair por e-mail sozinho, com ou sem a sua revisão antes.
- RelatóriosCompartilhar por link e baixar em PDFCrie um link público para o cliente abrir sem login, atualize ou revogue quando quiser e gere o PDF com as abas visíveis.