Analytics
SE Ranking no seu produto e nos seus agentes de IA, por uma API
O toolkit do SE Ranking cobre projetos, os mecanismos de busca e palavras-chave que rastreiam, posições de palavras-chave e histórico de ranking, concorrentes, auditorias de site e estatísticas de backlinks. Pelo Connect, seu produto ou agente de IA chama tudo por um só endpoint, enquanto o Connect guarda a chave de API e registra cada execução.
15 dias para testar. Sem cartão de crédito.
POST https://connect.reportei.com/api/tools/se_ranking_create_audit/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"domain": "<domain>"
}
}Como funciona
Do cliente conectado à primeira chamada no SE Ranking.
- 1
O cliente conecta a conta
Seu sistema abre uma sessão do Connect para o toolkit e o cliente conecta a conta do SE Ranking. Você recebe o id da conexão.
- 2
Seu produto chama a tool
Um POST em /api/tools/{tool}/execute com o id da conexão e os argumentos. Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app.
- 3
O Connect cuida do resto
Guarda a credencial criptografada, renova tokens quando a conexão usa OAuth com suporte a renovação e registra as execuções numa trilha de auditoria consultável pela API.
Para que usar
O que o seu produto faz com o SE Ranking.
Relatórios de SEO em marca própria
Uma ferramenta de agência lê o resumo de um projeto, as posições das palavras-chave e o histórico de ranking para montar o relatório do cliente.
Compare com concorrentes
Um SaaS lista os concorrentes de um projeto e obtém suas posições para as mesmas palavras-chave em um período.
Rode e leia auditorias de site
Um agente de IA inicia a auditoria de um domínio e depois lê o relatório, com a pontuação de saúde e os erros, avisos e notificações.
Tools
12 tools do SE Ranking
- Listar projetosGETLista os projetos da conta, cada um um site rastreado, com o id que as outras ferramentas pedem como site_id, título, URL, keyword_count, frequência de verificação e o guest_link para compartilhar os rankings sem login.
- Obter resumo do projetoGETRetorna o resumo de um projeto: a posição média das duas últimas verificações, quantas posições subiram e desceram, palavras-chave no top 5, 10 e 30, visibilidade, Domain Authority e páginas indexadas no Google.
- Listar mecanismos de busca do projetoGETLista os mecanismos de busca que um projeto rastreia, cada um com o site_engine_id que as ferramentas de ranking pedem, sua região, idioma e keyword_count.
- Listar palavras-chaveGETLista as palavras-chave que um projeto rastreia, com id, name (o texto da palavra-chave), link alvo, grupo e os site_engine_ids em que é rastreada. As ferramentas de ranking só retornam o id da palavra-chave, então é aqui que está o texto.
- Obter posições das palavras-chaveGETRetorna as posições das palavras-chave de um projeto em cada data de verificação de um período, agrupadas por mecanismo de busca, com a variação, o volume de busca e a concorrência de cada uma. As palavras-chave vêm por id: o texto está em Listar palavras-chave.
- Obter histórico de rankingGETRetorna uma série temporal de uma métrica de ranking de um projeto por data de verificação: uma série por mecanismo de busca e uma com a média de todos. value às vezes vem como texto e às vezes como número.
- Listar concorrentesGETLista os concorrentes adicionados a um projeto, com o id que Obter posições do concorrente pede, nome, URL e Domain Trust.
- Obter posições do concorrenteGETRetorna as posições de um concorrente para as palavras-chave do projeto em cada data de verificação de um período, agrupadas por mecanismo de busca, com o nome da palavra-chave e o volume de busca.
- Listar auditoriasGETLista as auditorias de site da conta, com id, url, título, status (como processing ou finished), last_update e as últimas estatísticas, e total como o número encontrado. A última página é quando offset mais limit alcança total.
- Criar auditoriaPOSTInicia a auditoria de site de um domínio e retorna seu id; Obter relatório da auditoria mostra is_finished quando termina. Usa os limites de auditoria do plano e, por padrão, o SE Ranking envia o relatório por e-mail ao dono da conta no fim, a menos que settings.send_report seja 0.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
Perguntas sobre o toolkit do SE Ranking
Preciso implementar a API do SE Ranking?
Não. O Connect já traz 12 tools do SE Ranking descritas e prontas. Seu cliente conecta a conta e o seu sistema chama cada tool pelo mesmo endpoint, com o mesmo formato de requisição.
Como o cliente conecta a conta do SE Ranking?
Pelo modo que o toolkit aceita: Chave de API. O Connect guarda a credencial criptografada e nunca a devolve ao seu sistema.
Funciona com agentes de IA?
Sim. O input de cada tool é descrito em JSON Schema, que o seu agente usa direto como definição de tool. O agente escolhe a tool e os argumentos, e o seu sistema faz a chamada ao Connect.
Meu cliente precisa ter conta no Reportei?
Não. O cliente conecta a conta numa tela do Connect, ou o seu sistema envia a credencial pela API, e ele continua usando só o seu produto.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
