Synupv1
Criar chave
v1Recursos/Listagens publicadas/getObter Índice de Citações

Obter Índice de Citações

Quantos diretórios indexam este local, atual em relação a um período anterior.

get/api/v1/seo/citation-index
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
availablebooleanopcional
Se já existe um snapshot do índice de citações para este local.
currentobjectopcional
O snapshot mais recente na ou antes do fim da janela.
percentagenumberopcional
Percentual de listagens atualmente indexadas (0–100), ou null.
listingsnumberopcional
Total de listagens ativas contabilizadas neste snapshot, ou null.
indexednumberopcional
Dessas, quantas estão indexadas, ou null.
previousobjectopcional
O snapshot mais recente na ou antes do início da janela, para comparação.
percentagenumberopcional
Percentual de listagens atualmente indexadas (0–100), ou null.
listingsnumberopcional
Total de listagens ativas contabilizadas neste snapshot, ou null.
indexednumberopcional
Dessas, quantas estão indexadas, ou null.
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/citation-index
Sua chave de API
locationId *
clientId
from
to
{
  "data": {
    "available": true,
    "current": {
      "percentage": 90.48,
      "listings": 42,
      "indexed": 38
    },
    "previous": {
      "percentage": 83.33,
      "listings": 42,
      "indexed": 35
    }
  }
}