Synupv1
Criar chave
v1Recursos/AEO/getObter o resumo AEO de todos os locais

Obter o resumo AEO de todos os locais

Retorna o resumo do relatório AEO mais recente por local, opcionalmente restrito a um cliente e/ou tags de local, além de dados de tendência e correções sistêmicas em todo o portfólio. Locais sem relatório ainda mostram pontuações null.

get/api/v1/aeo/rollup
aeo:read
Parâmetros de consulta
clientIdstringopcional
Restringe os resultados a um cliente. Quando sua chave está limitada a clientes específicos, isso é obrigatório.
tagsstringopcional
Lista de nomes de tags de local separados por vírgula. Somente locais com pelo menos uma dessas tags são incluídos.
Resposta
dataobjectopcional
rowsarray of objectopcional
Uma linha por local em escopo.
locationIdstringopcional
Identificador único do local.
namestringopcional
O nome comercial do local.
citystringopcional
Cidade, ou null.
overallnumberopcional
Pontuação geral de visibilidade em IA mais recente (0-100), ou null se nunca gerada.
chatgptnumberopcional
Pontuação do ChatGPT mais recente, ou null.
gemininumberopcional
Pontuação do Gemini mais recente, ou null.
perplexitynumberopcional
Pontuação do Perplexity mais recente, ou null.
generatedAtstringopcional
Quando o relatório mais recente foi gerado, como timestamp ISO 8601, ou null se nunca gerado.
yearMonthstringopcional
Mês do relatório mais recente (YYYY-MM), ou null.
tagsarray of stringopcional
As tags internas do local.
historyarray of numberopcional
Histórico de pontuação geral para este local, cronológico, apenas valores não nulos.
deltanumberopcional
Variação na pontuação geral em relação ao relatório anterior, ou null no primeiro relatório ou se não houver mês anterior.
topIssueobjectopcional
O fator de visibilidade mais fraco deste local, ou null se ainda não tiver relatório.
labelstringopcional
tonestring (good | warn | bad)opcional
configuredEnginesarray of string (ChatGPT | Gemini | Perplexity)opcional
Motores de IA para os quais esta agência tem uma chave de API configurada.
portfolioHistoryarray of objectopcional
Pontuação geral média entre os locais em escopo, por mês.
yearMonthstringopcional
Mês no formato YYYY-MM.
avgnumberopcional
Pontuação geral média entre os locais que reportaram naquele mês.
locationsnumberopcional
Número de locais com um relatório naquele mês (o denominador da média).
systemicFixesarray of objectopcional
Fraquezas entre locais compartilhadas por vários locais, cada uma com uma única correção em lote, classificadas por alcance.
factorstringopcional
Identificador legível por máquina do fator.
labelstringopcional
Nome legível do fator.
detailstringopcional
Explicação da fraqueza sistêmica.
targetstring (listings | citations | reviews | posts | competitors | prompts)opcional
Para qual parte do produto a correção direciona.
countnumberopcional
Número de locais afetados.
pctnumberopcional
Percentual de locais que reportaram afetados.
Erros
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.
get/api/v1/aeo/rollup
Sua chave de API
clientId
tags
{
  "data": {
    "rows": [
      {
        "locationId": "cm_loc_1",
        "name": "Acme Dental — Downtown",
        "city": "Austin",
        "overall": 62,
        "chatgpt": 68,
        "gemini": 56,
        "perplexity": null,
        "generatedAt": "2026-02-01T06:00:00.000Z",
        "yearMonth": "2026-02",
        "tags": [
          "priority"
        ],
        "history": [
          57,
          62
        ],
        "delta": 5,
        "topIssue": null
      }
    ],
    "configuredEngines": [
      "ChatGPT",
      "Gemini"
    ],
    "portfolioHistory": [
      {
        "yearMonth": "2026-01",
        "avg": 57,
        "locations": 5
      },
      {
        "yearMonth": "2026-02",
        "avg": 62,
        "locations": 5
      }
    ],
    "systemicFixes": [
      {
        "factor": "citations",
        "label": "Citations",
        "detail": "6 locations are missing citations on Yelp.",
        "target": "citations",
        "count": 6,
        "pct": 30
      }
    ]
  }
}