Obter posições do concorrente no SE Ranking, por uma API

Retorna 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.

Identificador
se_ranking_get_competitor_positions

A chamada

POST https://connect.reportei.com/api/tools/se_ranking_get_competitor_positions/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "competitor_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âmetroTipoObrigatórioDescrição
competitor_idintegerSimId of the competitor, from List competitors.
with_serp_featuresintegerNão1 adds the Google SERP features found for each keyword.Valores: 0, 1
site_engine_idintegerNãoOnly this search engine of the project, from List project search engines. All of them by default.
date_fromstringNãoFirst day of the period, as YYYY-MM-DD. The default is one week ago.
date_tostringNãoLast day of the period, as YYYY-MM-DD. The default is today.

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_get_competitor_positions. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do SE Ranking

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.