Synupv1
Criar chave
v1Recursos/Listagens publicadas/getObter Share of Voice

Obter Share of Voice

Sua participação no Grid Rank em relação a concorrentes nomeados, suas palavras-chave de melhor desempenho classificadas pela participação top-3 mais recente, e uma tendência mensal de posição média na janela — para um local.

get/api/v1/seo/share-of-voice
seo:read
Parâmetros de consulta
locationIdstringobrigatório
O local a consultar. Procure com GET /api/v1/locations.
clientIdstringopcional
O cliente do local. Necessário apenas para desambiguar quando sua chave é limitada a clientes específicos.
fromstringopcional
Início da janela (data ISO). Padrão: 30 dias atrás.
tostringopcional
Fim da janela (data ISO). Padrão: agora.
Resposta
dataobjectopcional
comparisonobjectopcional
Você em relação a concorrentes nomeados pela participação top-3 do grid.
availablebooleanopcional
Se este local tem dados de grid-rank para calcular o Share of Voice.
rowsarray of objectopcional
Uma linha por empresa na comparação — você e seus concorrentes nomeados.
namestringopcional
O nome da empresa, ou o nome do seu próprio cliente na sua própria linha.
top3Pctnumberopcional
Percentual de palavras-chave rastreadas em que esta empresa está entre as 3 primeiras posições (0–100), ou null se não houver dados suficientes.
isYoubooleanopcional
True na linha do seu próprio local. Omitido (nunca false) nas linhas de concorrentes.
keywordsobjectopcional
As palavras-chave deste local, classificadas pela participação top-3 mais recente.
availablebooleanopcional
Se este local tem dados de grid-rank para calcular o Share of Voice.
rowsarray of objectopcional
Uma linha por palavra-chave rastreada.
keywordstringopcional
A palavra-chave rastreada.
top3Pctnumberopcional
Percentual de palavras-chave rastreadas em que esta empresa está entre as 3 primeiras posições (0–100), ou null se não houver dados suficientes.
avgRanknumberopcional
Posição média no período, ou null se não houver dados suficientes.
performanceobjectopcional
Tendência mensal de posição média por palavra-chave, limitada por from/to.
availablebooleanopcional
Se este local tem dados de grid-rank para calcular o Share of Voice.
seriesarray of objectopcional
Uma série por palavra-chave rastreada.
keywordstringopcional
A palavra-chave rastreada.
pointsarray of objectopcional
Pontos de dados de posição média mensal para esta palavra-chave.
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.
get/api/v1/seo/share-of-voice
Sua chave de API
locationId *
clientId
from
to
{
  "data": {
    "comparison": {
      "available": true,
      "rows": [
        {
          "name": "Acme Dental — Downtown",
          "top3Pct": 62,
          "isYou": true
        },
        {
          "name": "Bright Smiles Dental",
          "top3Pct": 74
        }
      ]
    },
    "keywords": {
      "available": true,
      "rows": [
        {
          "keyword": "dentist near me",
          "top3Pct": 62,
          "avgRank": 3.2
        }
      ]
    },
    "performance": {
      "available": true,
      "series": [
        {
          "keyword": "dentist near me",
          "points": [
            {
              "yearMonth": "2026-01",
              "avgRank": 3.6
            },
            {
              "yearMonth": "2026-02",
              "avgRank": 3.2
            }
          ]
        }
      ]
    }
  }
}