Obtener posiciones del competidor en SE Ranking, con una API

Devuelve las posiciones de un competidor para las palabras clave del proyecto en cada fecha de comprobación de un periodo, agrupadas por buscador, con el nombre de la palabra clave y el volumen de búsqueda.

Identificador
se_ranking_get_competitor_positions

La llamada

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
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
competitor_idintegerSíId of the competitor, from List competitors.
with_serp_featuresintegerNo1 adds the Google SERP features found for each keyword.Valores: 0, 1
site_engine_idintegerNoOnly this search engine of the project, from List project search engines. All of them by default.
date_fromstringNoFirst day of the period, as YYYY-MM-DD. The default is one week ago.
date_tostringNoLast day of the period, as YYYY-MM-DD. The default is today.

Conexiones posibles

Tu cliente conecta su cuenta de SE Ranking una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/se_ranking_get_competitor_positions. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de SE Ranking

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.