Synupv1
Crear clave
v1Recursos/SEO

SEO

Haga seguimiento del posicionamiento de palabras clave en búsquedas locales sobre una cuadrícula geográfica, y de la posición frente a la competencia.

Devuelve las palabras clave seguidas, la tendencia de posición mensual, la cuadrícula de posicionamiento y las tarjetas de estadísticas de una ubicación. Indique keywordId para limitar la cuadrícula a una sola palabra clave, o month (YYYY-MM) para fijarla a un mes específico en lugar del último informe medido de cada palabra clave.

Obtener el resumen de posicionamiento de una ubicación

get/api/v1/seo/keywords
seo:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringopcional
El cliente de la ubicación.
keywordIdstringopcional
Restringe la cuadrícula a una palabra clave seguida. Omítalo para la cuadrícula agregada de mejor posición por celda entre todas las palabras clave activas.
monthstringopcional
Fija la cuadrícula y las estadísticas a este mes (YYYY-MM) en lugar del último informe medido de cada palabra clave.
Respuesta
dataobjectopcional
Puede haber campos internos adicionales que no forman parte del contrato estable — dependa únicamente de los campos documentados aquí.
keywordsarray of objectopcional
Palabras clave seguidas de esta ubicación, cada una con su posición actual y su tendencia mensual.
idstringopcional
Identificador único de la palabra clave seguida.
keywordstringopcional
El texto de la palabra clave.
avgRanknumberopcional
La última posición promedio medida de la palabra clave en toda la cuadrícula (cuanto más bajo, mejor; null si nunca se midió o no está posicionando).
monthlyarray of objectopcional
La posición promedio de esta palabra clave para cada mes en que tiene un informe.
monthstringopcional
ranknumberopcional
monthsarray of objectopcional
Todos los meses con al menos un informe medido, del más antiguo al más reciente, con la posición promedio media entre palabras clave para ese mes.
keystringopcional
Mes en formato YYYY-MM.
labelstringopcional
Etiqueta legible para el mes, p. ej. "Aug 2026".
avgRanknumberopcional
Posición promedio media entre las palabras clave seguidas para este mes, o null.
gridarray of objectopcional
La cuadrícula de posicionamiento: una entrada por punto rastreado, combinada entre las palabras clave/mes en alcance.
idstringopcional
rowintegeropcional
Índice de fila de la cuadrícula.
colintegeropcional
Índice de columna de la cuadrícula.
latnumberopcional
Latitud de este punto de la cuadrícula.
lngnumberopcional
Longitud de este punto de la cuadrícula.
ranknumberopcional
Posición encontrada en este punto (cuanto más bajo, mejor); null si no se midió, los valores superiores a 20 significan "20+".
excludedbooleanopcional
Si este punto está excluido de los cálculos de estadísticas de la ubicación.
waterbooleanopcional
Si este punto cae en agua (mar, lago, río ancho) y solo se cuenta si la ubicación ha optado por incluir puntos de agua.
statsobjectopcional
Estadísticas de posición agregadas en toda la cuadrícula activa.
top3Pctnumberopcional
Porcentaje de puntos de la cuadrícula que posicionan en el top 3, o null.
top10Pctnumberopcional
Porcentaje de puntos de la cuadrícula que posicionan en el top 10, o null.
avgRanknumberopcional
Posición promedio en toda la cuadrícula, o null.
statCardsobjectopcional
Tarjetas destacadas que resumen la mejor/peor palabra clave de la ubicación y el mayor movimiento mes a mes.
bestobjectopcional
La palabra clave con la mejor (más baja) posición promedio actual, o null si ninguna ha posicionado.
keywordstringopcional
avgRanknumberopcional
worstobjectopcional
La palabra clave con la peor posición promedio actual, o null.
keywordstringopcional
avgRanknumberopcional
gainerobjectopcional
La palabra clave cuya posición mejoró más desde su primer mes hasta el más reciente, o null.
keywordstringopcional
fromnumberopcional
tonumberopcional
dropperobjectopcional
La palabra clave cuya posición empeoró más desde su primer mes hasta el más reciente, o null.
keywordstringopcional
fromnumberopcional
tonumberopcional
notRankingCountnumberopcional
Puntos de la cuadrícula que se midieron correctamente pero posicionan fuera del top 20, o null.
noDataCountnumberopcional
Puntos de la cuadrícula que no se pudieron medir en absoluto (falló el rastreo), distinto de no posicionar, o null.
centerobjectopcional
El punto central del mapa para la cuadrícula de esta ubicación (su ubicación de negocio), o null si aún no está configurado.
latnumberopcional
lngnumberopcional
includeWaterPointsbooleanopcional
Si esta ubicación ha optado por contar los puntos de la cuadrícula que caen en agua.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/seo/keywords
Su clave de API
locationId *
clientId
keywordId
month
{
  "data": {
    "keywords": [
      {
        "id": "cm_kw_abc123",
        "keyword": "dentist near me",
        "avgRank": 4.2,
        "monthly": [
          {
            "month": "2026-01",
            "rank": 5.1
          },
          {
            "month": "2026-02",
            "rank": 4.2
          }
        ]
      }
    ],
    "months": [
      {
        "key": "2026-01",
        "label": "Jan 2026",
        "avgRank": 5.1
      },
      {
        "key": "2026-02",
        "label": "Feb 2026",
        "avgRank": 4.2
      }
    ],
    "grid": [
      {
        "id": "cm_pt_1",
        "row": 0,
        "col": 0,
        "lat": 30.2682,
        "lng": -97.7441,
        "rank": 3,
        "excluded": false,
        "water": false
      }
    ],
    "stats": {
      "top3Pct": 44,
      "top10Pct": 78,
      "avgRank": 4.2
    },
    "statCards": {
      "best": {
        "keyword": "dentist near me",
        "avgRank": 4.2
      },
      "worst": {
        "keyword": "emergency dentist austin",
        "avgRank": 9.6
      },
      "gainer": {
        "keyword": "dentist near me",
        "from": 5.1,
        "to": 4.2
      },
      "dropper": {
        "keyword": "family dentist",
        "from": 3.8,
        "to": 5.2
      },
      "notRankingCount": 1,
      "noDataCount": 0
    },
    "center": {
      "lat": 30.2672,
      "lng": -97.7431
    },
    "includeWaterPoints": false
  }
}
v1Recursos/SEO/postAgregar palabras clave seguidas a una ubicación

Empieza a seguir una o varias palabras clave en la cuadrícula de posicionamiento en búsquedas locales de una ubicación, configurando el tamaño de la cuadrícula y el radio la primera vez que se configura la ubicación. Las palabras clave se deduplican sin distinción de mayúsculas y se limitan a 25 por ubicación. Dispara un escaneo de posicionamiento en segundo plano para cada palabra clave recién agregada — consulte GET /api/v1/seo/keywords después para ver los resultados.

Agregar palabras clave seguidas a una ubicación

post/api/v1/seo/keywords
seo:write
Cuerpo de la solicitud
locationIdstringobligatorio
La ubicación para la que se seguirán palabras clave.
clientIdstringopcional
El cliente de la ubicación.
keywordsarray of stringobligatorio
Palabras clave a empezar a seguir, hasta 25 (deduplicadas sin distinción de mayúsculas; prevalece la primera grafía enviada).
gridSizeinteger (3 | 5 | 7)opcional
Tamaño de la cuadrícula (3, 5 o 7 puntos por lado). Solo se aplica la primera vez que se configura la cuadrícula de esta ubicación — las llamadas posteriores que lo omitan, o que apunten a una ubicación ya configurada, dejan sin cambios el tamaño de cuadrícula almacenado.
distanceKmnumberopcional
Distancia en kilómetros entre puntos adyacentes de la cuadrícula. Sigue la misma regla de solo-la-primera-vez que gridSize; el valor predeterminado es 1.5 km cuando la ubicación aún no tiene una cuadrícula configurada.
excludedarray of objectopcional
Puntos de la cuadrícula a excluir de la medición — p. ej. un lago, el territorio de un competidor. Los puntos se siguen rastreando de todos modos; esto solo controla si cuentan en las estadísticas.
rowintegeropcional
Índice de fila de la cuadrícula, empezando en 0.
colintegeropcional
Índice de columna de la cuadrícula, empezando en 0.
Respuesta
dataobjectopcional
keywordsarray of objectopcional
Las palabras clave que se agregaron o reactivaron con esta llamada.
idstringopcional
Identificador único de la palabra clave seguida.
keywordstringopcional
El texto de la palabra clave tal como se almacenó (usando la primera grafía enviada).
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/seo/keywords
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "keywords": [
      {
        "id": "cm_kw_abc123",
        "keyword": "dentist near me"
      }
    ]
  }
}
v1Recursos/SEO/deleteEliminar una palabra clave seguida

Deja de seguir una palabra clave y elimina sus informes de posicionamiento almacenados.

Eliminar una palabra clave seguida

delete/api/v1/seo/keywords
seo:write
Parámetros de consulta
keywordIdstringobligatorio
La palabra clave seguida a eliminar.
clientIdstringopcional
El cliente de la ubicación propietaria de la palabra clave.
Respuesta
dataobjectopcional
removedbooleanopcional
Siempre true — se eliminaron la palabra clave y sus informes de posicionamiento almacenados.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/seo/keywords
Su clave de API
keywordId *
clientId
{
  "data": {
    "removed": true
  }
}
v1Recursos/SEO/patchActualizar la configuración de cuadrícula de una ubicación

Actualiza la configuración de medición de la cuadrícula de una ubicación: tamaño de cuadrícula, distancia entre puntos, puntos excluidos, o si los puntos de agua cuentan en las estadísticas. Indique solo los campos que desea cambiar. Los puntos de agua siempre se rastrean de todos modos — includeWaterPoints solo controla si se cuentan y se muestran. El lado de lectura ya está cubierto por GET /api/v1/seo/keywords, cuya respuesta ya incluye includeWaterPoints.

Actualizar la configuración de cuadrícula de una ubicación

patch/api/v1/seo/config
seo:write
Cuerpo de la solicitud
locationIdstringobligatorio
La ubicación a configurar.
clientIdstringopcional
El cliente de la ubicación.
gridSizeinteger (3 | 5 | 7)opcional
Tamaño de la cuadrícula: 3, 5 o 7.
distanceKmnumberopcional
Distancia en kilómetros entre puntos adyacentes de la cuadrícula.
excludedarray of objectopcional
Puntos de la cuadrícula a excluir de la medición.
rowintegeropcional
Índice de fila de la cuadrícula, empezando en 0.
colintegeropcional
Índice de columna de la cuadrícula, empezando en 0.
includeWaterPointsbooleanopcional
Si los puntos de agua de la cuadrícula cuentan en las estadísticas.
Respuesta
dataobjectopcional
configobjectopcional
La configuración de cuadrícula de la ubicación tras la actualización.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
patch/api/v1/seo/config
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "config": {
      "id": "cm_cfg_abc123",
      "synupLocationId": "os_9f8e7d6c",
      "clientLocationId": "cm_loc_1",
      "agencyId": "cm_agency_1",
      "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
      "centerLat": 30.2672,
      "centerLng": -97.7431,
      "gridSize": 5,
      "distanceKm": 1.5,
      "excludedPoints": [
        {
          "row": 4,
          "col": 4
        }
      ],
      "generationStartedAt": null,
      "lastRunStatus": "complete",
      "lastError": null,
      "includeWaterPoints": true,
      "lastGeneratedAt": "2026-02-01T06:00:00.000Z",
      "createdAt": "2026-01-10T09:00:00.000Z",
      "updatedAt": "2026-02-05T10:00:00.000Z"
    }
  }
}
v1Recursos/SEO/postDescargar un informe de posicionamiento con marca

Genera el informe de posicionamiento con marca y secciones configurables — la misma acción "Descargar informe" de la aplicación. Devuelve HTML renderizado, no un PDF binario: la conversión a PDF ocurre en el navegador (no hay un renderizador Chrome sin interfaz en el servidor), así que convertir esto en un archivo PDF real corre por cuenta de quien llama, la misma limitación que tiene la propia interfaz de la aplicación. Distinto de POST /api/v1/seo/reports/generate, que solo encola un escaneo de la cuadrícula de posicionamiento en segundo plano y no devuelve ningún documento.

Descargar un informe de posicionamiento con marca

post/api/v1/seo/reports
seo:read
Cuerpo de la solicitud
locationIdstringobligatorio
La ubicación sobre la que informar.
presetstringopcional
Preajuste de rango de fechas, p. ej. "lastMonth" (predeterminado).
fromstringopcional
Inicio del rango personalizado (fecha ISO). Requiere to.
tostringopcional
Fin del rango personalizado (fecha ISO). Requiere from.
keywordsarray of stringopcional
Limitar a estos ids de palabras clave seguidas. Omitir para incluirlas todas.
sectionsobjectopcional
Qué secciones del informe incluir, por clave. Las claves omitidas usan los valores predeterminados del informe.
coverPagebooleanopcional
executiveSummarybooleanopcional
performanceSnapshotbooleanopcional
agencyActivityLogbooleanopcional
gridRankSnapshotsbooleanopcional
keywordPerformanceTablebooleanopcional
monthOverMonthTrendbooleanopcional
competitorLandscapebooleanopcional
aiRecommendationsbooleanopcional
notesstringopcional
Notas de texto libre para incluir en el informe.
localestringopcional
Idioma del informe generado. Por defecto en.
Respuesta
dataobjectopcional
htmlstringopcional
El informe generado como documento HTML autocontenido.
filenamestringopcional
Nombre de archivo sugerido para el informe.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
502No se pudo generar el informe (un fallo del origen de datos, no un error del cliente).
post/api/v1/seo/reports
Su clave de API
Cuerpo de la solicitud*
{
  "data": {
    "html": "<style>#seo-report{width:100%;...}</style><div id=\"seo-report\"><section class=\"cover\"><h1>Ranking Analytics Report</h1><div class=\"biz\">Acme Dental — Downtown</div></section>...</div>",
    "filename": "Acme_Dental_Downtown_RankingReport_Jan2026_Feb2026.pdf"
  }
}
v1Recursos/SEO/getObtener el resumen de posicionamiento de todas las ubicaciones

Devuelve una fila de resumen por cada ubicación que tenga al menos un informe de posicionamiento, opcionalmente limitada a un cliente y/o etiquetas de ubicación. Una clave restringida a clientes específicos debe indicar clientId.

Obtener el resumen de posicionamiento de todas las ubicaciones

get/api/v1/seo/rollup
seo:read
Parámetros de consulta
clientIdstringopcional
Restringe los resultados a un cliente. Cuando su clave está limitada a clientes específicos, esto es obligatorio.
tagsstringopcional
Nombres de etiquetas de ubicación separados por comas. Solo se incluyen las ubicaciones que tengan al menos una de estas etiquetas.
Respuesta
dataobjectopcional
countnumberopcional
Número de filas devueltas.
rowsarray of objectopcional
Una fila por ubicación con al menos un informe de posicionamiento.
idstringopcional
Identificador único de la ubicación.
locationNamestringopcional
El nombre comercial de la ubicación.
citystringopcional
Ciudad, o null.
avgRanknumberopcional
Posición promedio media entre las palabras clave activas de la ubicación, o null.
top3Pctnumberopcional
Porcentaje medio de puntos de la cuadrícula en el top 3 entre las palabras clave de la ubicación, o null.
top10Pctnumberopcional
Porcentaje medio de puntos de la cuadrícula en el top 10 entre las palabras clave de la ubicación, o null.
bestKeywordobjectopcional
La palabra clave mejor posicionada de la ubicación, o null.
keywordstringopcional
avgRanknumberopcional
tagsarray of stringopcional
Las etiquetas internas de la ubicación.
Errores
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/seo/rollup
Su clave de API
clientId
tags
{
  "data": {
    "count": 2,
    "rows": [
      {
        "id": "cm_loc_1",
        "locationName": "Acme Dental — Downtown",
        "city": "Austin",
        "avgRank": 4.2,
        "top3Pct": 44,
        "top10Pct": 78,
        "bestKeyword": {
          "keyword": "dentist near me",
          "avgRank": 4.2
        },
        "tags": [
          "priority",
          "downtown"
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObtener la tabla de clasificación de competidores de una ubicación

Devuelve los negocios que dominan la cuadrícula de posicionamiento de esta ubicación para su palabra clave seguida más reciente, clasificados por cuánto de la cuadrícula ocupan en el top 3. Incluye su propio negocio (isYou) para comparación, y etiqueta las entradas que ya están en su registro de competidores seguidos con su ID de registro.

Obtener la tabla de clasificación de competidores de una ubicación

get/api/v1/seo/competitors
seo:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringopcional
El cliente de la ubicación.
Respuesta
dataobjectopcional
countnumberopcional
Número de competidores devueltos.
competitorsarray of objectopcional
La tabla de clasificación de competidores, incluido su propio negocio.
idstringopcional
Un identificador para este negocio (su ID de lugar, o una clave derivada cuando no hay un ID de lugar disponible).
competitorIdstringopcional
ID en su registro de competidores seguidos, presente solo cuando este negocio ya está registrado allí.
namestringopcional
Nombre del negocio.
isYoubooleanopcional
Si esta fila es su propio negocio.
ratingnumberopcional
Calificación en estrellas, o null.
reviewCountnumberopcional
Número de reseñas, o null.
avgRanknumberopcional
Posición promedio en los puntos de la cuadrícula donde apareció este negocio, o null.
top3Pctnumberopcional
Porcentaje de puntos de la cuadrícula donde este negocio posiciona en el top 3, promediado entre todas las palabras clave seguidas.
gridPointsnumberopcional
Número de puntos de la cuadrícula donde apareció este negocio.
categorystringopcional
Categoría del negocio, o null.
websitestringopcional
Sitio web del negocio, o null (la fuente de datos de búsqueda local no lo devuelve).
keywordBreakdownarray of objectopcional
La cobertura en el top 3 de este negocio, desglosada por cada palabra clave seguida.
keywordstringopcional
La palabra clave seguida.
top3Pctnumberopcional
Porcentaje de los puntos de la cuadrícula de esa palabra clave donde este negocio posiciona en el top 3.
featureComparisonarray of objectopcional
Filas de comparación característica por característica frente a su negocio, si las hay.
featurestringopcional
competitorbooleanopcional
youbooleanopcional
hoursComparisonarray of objectopcional
Filas de comparación de horario comercial frente a su negocio, si las hay.
daystringopcional
competitorstringopcional
youstringopcional
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/seo/competitors
Su clave de API
locationId *
clientId
{
  "data": {
    "count": 2,
    "competitors": [
      {
        "id": "cm_comp_1",
        "competitorId": "cm_competitor_1",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "rating": 4.6,
        "reviewCount": 210,
        "avgRank": 4.2,
        "top3Pct": 44,
        "gridPoints": 25,
        "category": "Dentist",
        "website": "https://acmedental.example.com",
        "keywordBreakdown": [
          {
            "keyword": "dentist near me",
            "top3Pct": 60
          }
        ],
        "featureComparison": [
          {
            "feature": "Online booking",
            "competitor": false,
            "you": true
          }
        ],
        "hoursComparison": [
          {
            "day": "Monday",
            "competitor": "9am–5pm",
            "you": "8am–6pm"
          }
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObtener la tendencia de posición de los competidores a lo largo del tiempo

Devuelve la posición promedio mensual de cada competidor a lo largo del historial de posicionamiento seguido de esta ubicación (hasta los últimos 12 meses medidos), para el gráfico de tendencia de posición. Incluye su propio negocio (isYou).

Obtener la tendencia de posición de los competidores a lo largo del tiempo

get/api/v1/seo/competitors/trends
seo:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
clientIdstringopcional
El cliente de la ubicación.
Respuesta
dataobjectopcional
monthsarray of stringopcional
Meses cubiertos, del más antiguo al más reciente (YYYY-MM).
competitorsarray of objectopcional
Una serie por competidor (además de su propio negocio), alineada con months.
placeIdstringopcional
Un identificador para este negocio (su ID de lugar, o una clave derivada).
namestringopcional
Nombre del negocio.
isYoubooleanopcional
Si esta serie es su propio negocio.
monthlyarray of numberopcional
Posición promedio para cada mes en months; null cuando este negocio no se observó ese mes.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/seo/competitors/trends
Su clave de API
locationId *
clientId
{
  "data": {
    "months": [
      "2026-01",
      "2026-02"
    ],
    "competitors": [
      {
        "placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
        "name": "Acme Dental — Downtown",
        "isYou": true,
        "monthly": [
          5.1,
          4.2
        ]
      }
    ]
  }
}
v1Recursos/SEO/getObtener los negocios posicionados en un punto de la cuadrícula

Devuelve los resultados de búsqueda local capturados en una sola celda de la cuadrícula para una palabra clave, en orden de posición.

Obtener los negocios posicionados en un punto de la cuadrícula

get/api/v1/seo/grid-point
seo:read
Parámetros de consulta
locationIdstringobligatorio
La ubicación a consultar.
keywordIdstringobligatorio
La palabra clave seguida a cuya cuadrícula pertenece este punto.
rowintegerobligatorio
Índice de fila de la cuadrícula del punto.
colintegerobligatorio
Índice de columna de la cuadrícula del punto.
clientIdstringopcional
El cliente de la ubicación.
monthstringopcional
Fija el resultado a este mes (YYYY-MM) en lugar del último informe medido de la palabra clave.
Respuesta
dataobjectopcional
countnumberopcional
Número de negocios devueltos.
businessesarray of objectopcional
Negocios posicionados en este punto de la cuadrícula, en orden de posición.
idstringopcional
Un identificador para este negocio (su ID de lugar, nombre o posición en la lista).
ranknumberopcional
La posición de este negocio en este punto de la cuadrícula (1 = el primero).
namestringopcional
Nombre del negocio.
photoUrlstringopcional
URL de la foto, o null (la fuente de datos de búsqueda local no la devuelve).
ratingnumberopcional
Calificación en estrellas, o null.
reviewCountnumberopcional
Número de reseñas, o null.
categorystringopcional
Categoría del negocio, o null.
addressstringopcional
Dirección postal, o null.
websitestringopcional
Sitio web del negocio, o null (la fuente de datos de búsqueda local no lo devuelve).
isYoubooleanopcional
Si esta fila es su propio negocio.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/seo/grid-point
Su clave de API
locationId *
keywordId *
row *
col *
clientId
month
{
  "data": {
    "count": 1,
    "businesses": [
      {
        "id": "cm_biz_1",
        "rank": 3,
        "name": "Acme Dental — Downtown",
        "photoUrl": null,
        "rating": 4.6,
        "reviewCount": 210,
        "category": "Dentist",
        "address": "123 Main St, Austin, TX 78701",
        "website": null,
        "isYou": true
      }
    ]
  }
}
v1Recursos/SEO/postRegenerar el informe de la cuadrícula de posicionamiento de una ubicación

Dispara un nuevo rastreo en segundo plano de la cuadrícula de posicionamiento en búsquedas locales para una ubicación y/o una palabra clave seguida específica. Esto es de disparar y olvidar: la llamada regresa de inmediato una vez encolado el trabajo, y el nuevo informe llega de forma asíncrona — consulte después GET /api/v1/seo/keywords (o GET /api/v1/seo/competitors, etc.) para verlo.

Regenerar el informe de la cuadrícula de posicionamiento de una ubicación

post/api/v1/seo/reports/generate
seo:write
Cuerpo de la solicitud
locationIdstringopcional
Regenera la cuadrícula de todas las palabras clave activas de esta ubicación. Opcional si se indica keywordId.
keywordIdstringopcional
Regenera la cuadrícula solo para esta palabra clave seguida. Opcional si se indica locationId.
monthstringopcional
Genera la cuadrícula de posicionamiento de este mes (YYYY-MM) en lugar del mes actual.
clientIdstringopcional
El cliente de la ubicación (o de la ubicación propietaria de la palabra clave).
Respuesta
dataobjectopcional
generatingbooleanopcional
Siempre true — se encoló un trabajo de generación en segundo plano.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/seo/reports/generate
Su clave de API
Cuerpo de la solicitud
{
  "data": {
    "generating": true
  }
}