Synup
Criar chave
v1Recursos/SEO/postBaixar um relatório de classificação com identidade visual

Baixar um relatório de classificação com identidade visual

Gera o relatório de classificação com identidade visual e seções configuráveis — a mesma ação "Baixar relatório" no aplicativo. Retorna HTML renderizado, não um PDF binário: a renderização em PDF acontece no navegador (nenhum renderizador Chrome headless é executado no servidor), então transformar isso em um arquivo PDF real fica por conta de quem chama, a mesma limitação que a própria interface do aplicativo tem. Diferente de POST /api/v1/seo/reports/generate, que apenas enfileira uma varredura da grade de classificação em segundo plano e não retorna documento algum.

post/api/v1/seo/reports
seo:read
Corpo da solicitação
locationIdstringobrigatório
O local sobre o qual gerar o relatório.
presetstringopcional
Predefinição de período, ex.: "lastMonth" (padrão).
fromstringopcional
Início do período personalizado (data ISO). Requer to.
tostringopcional
Fim do período personalizado (data ISO). Requer from.
keywordsarray of stringopcional
Limitar a esses ids de palavras-chave monitoradas. Omita para incluir todas.
sectionsobjectopcional
Quais seções do relatório incluir, por chave. Chaves omitidas usam os padrões do relatório.
coverPagebooleanopcional
executiveSummarybooleanopcional
performanceSnapshotbooleanopcional
agencyActivityLogbooleanopcional
gridRankSnapshotsbooleanopcional
keywordPerformanceTablebooleanopcional
monthOverMonthTrendbooleanopcional
competitorLandscapebooleanopcional
aiRecommendationsbooleanopcional
notesstringopcional
Notas em texto livre para incluir no relatório.
localestringopcional
Idioma do relatório gerado. Padrão en.
Resposta
dataobjectopcional
htmlstringopcional
O relatório gerado como um documento HTML autocontido.
filenamestringopcional
Nome de arquivo sugerido para o relatório.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
502O relatório não pôde ser gerado (uma falha na fonte de dados, não um erro do cliente).
post/api/v1/seo/reports
Sua chave de API
Corpo da solicitação*
{
  "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"
  }
}

Guias que usam este recurso