Synup
Crear clave
v1Recursos/SEO/postDescargar un informe de posicionamiento con marca

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

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

Guías que usan este recurso