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
seo:read/api/v1/seo/citation-indexParâ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.
weekStartstringopcional
A semana do instantâneo, como segunda-feira às 00:00 UTC.
recordedAtstringopcional
Quando este instantâneo foi gravado pela última vez.
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.
weekStartstringopcional
A semana do instantâneo, como segunda-feira às 00:00 UTC.
recordedAtstringopcional
Quando este instantâneo foi gravado pela última vez.
inventoryobjectopcional
As páginas de listagem publicadas hoje para este local, cada uma com seu último resultado registrado. Não é comparável aos instantâneos semanais de current e previous.
basisstring (current_inventory)obrigatório
Sempre current_inventory: são as páginas de hoje, não um instantâneo anterior.
pagesarray of objectobrigatório
Uma entrada por página de listagem publicada.
idstringobrigatório
O id da listagem.
publisherIdstringobrigatório
O id do publisher.
namestringobrigatório
O nome do publisher.
urlstringobrigatório
A URL da página de listagem publicada. Null quando o link armazenado não é uma URL http(s) absoluta.
statusstring (indexed | not_indexed | pending | not_checked)obrigatório
O último resultado registrado, não uma verificação em tempo real: indexed, not_indexed, pending ou not_checked. pending e not_checked são desconhecidos, nunca um resultado negativo.
checkedAtstringobrigatório
Quando a última verificação foi registrada, ou null.
indexedAtstringobrigatório
Quando a página foi confirmada como indexada, ou null. Uma página confirmada como indexada não é verificada novamente.
countsobjectobrigatório
As páginas, contadas por status.
totalintegerobrigatório
Páginas de listagem publicadas.
indexedintegerobrigatório
Páginas exibidas na Pesquisa Google.
notIndexedintegerobrigatório
Páginas com resultado registrado de não indexada.
pendingintegerobrigatório
Páginas aguardando um resultado. Desconhecido, nunca um resultado negativo.
notCheckedintegerobrigatório
Páginas ainda sem resultado utilizável. Desconhecido, nunca um resultado negativo.
latestEvidenceAtstringobrigatório
Quando a verificação ou confirmação mais recente das páginas foi registrada, ou null. Pode ser uma data de confirmação sem uma nova verificação por trás.
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
}
}
}