Listar mecanismos de busca do projeto no SE Ranking, por uma API
Lista 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.
- Identificador
- se_ranking_list_project_search_engines
A chamada
POST https://connect.reportei.com/api/tools/se_ranking_list_project_search_engines/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": 1
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| site_id | integer | Sim | Id of the project, from List projects. |
Conexões possíveis
O seu cliente conecta a conta do SE Ranking uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
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.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/se_ranking_list_project_search_engines. Ele vira a definição de tool do seu agente sem conversão.
Outras 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 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.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
