v1Ressources/Fiches publiées/getObtenir l'Indice de Citations
Obtenir l'Indice de Citations
Combien d'annuaires indexent cet emplacement, actuellement face à une période antérieure.
get
seo:read/api/v1/seo/citation-indexParamètres de requête
locationIdstringobligatoire
L'emplacement à consulter. Retrouvez-le avec GET /api/v1/locations.
clientIdstringfacultatif
Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.
fromstringfacultatif
Début de la fenêtre (date ISO). Par défaut, il y a 30 jours.
tostringfacultatif
Fin de la fenêtre (date ISO). Par défaut, maintenant.
Réponse
dataobjectfacultatif
availablebooleanfacultatif
Si un instantané de l'indice de citations existe déjà pour cet emplacement.
currentobjectfacultatif
Le dernier instantané à la fin de la fenêtre ou avant.
percentagenumberfacultatif
Pourcentage de fiches actuellement indexées (0–100), ou null.
listingsnumberfacultatif
Nombre total de fiches actives comptabilisées dans cet instantané, ou null.
indexednumberfacultatif
Parmi elles, combien sont indexées, ou null.
weekStartstringfacultatif
La semaine de l'instantané, sous la forme lundi 00:00 UTC.
recordedAtstringfacultatif
Date de dernière écriture de cet instantané.
previousobjectfacultatif
Le dernier instantané au début de la fenêtre ou avant, pour comparaison.
percentagenumberfacultatif
Pourcentage de fiches actuellement indexées (0–100), ou null.
listingsnumberfacultatif
Nombre total de fiches actives comptabilisées dans cet instantané, ou null.
indexednumberfacultatif
Parmi elles, combien sont indexées, ou null.
weekStartstringfacultatif
La semaine de l'instantané, sous la forme lundi 00:00 UTC.
recordedAtstringfacultatif
Date de dernière écriture de cet instantané.
inventoryobjectfacultatif
Les pages de fiche en ligne de cet emplacement aujourd'hui, chacune avec son dernier résultat enregistré. Non comparable aux instantanés hebdomadaires de current et previous.
basisstring (current_inventory)obligatoire
Toujours current_inventory : ce sont les pages d'aujourd'hui, pas un instantané passé.
pagesarray of objectobligatoire
Une entrée par page de fiche en ligne.
idstringobligatoire
L'id de la fiche.
publisherIdstringobligatoire
L'id du publisher.
namestringobligatoire
Le nom du publisher.
urlstringobligatoire
L'URL de la page de fiche en ligne. Null lorsque le lien enregistré n'est pas une URL http(s) absolue.
statusstring (indexed | not_indexed | pending | not_checked)obligatoire
Le dernier résultat enregistré, pas une vérification en direct : indexed, not_indexed, pending ou not_checked. pending et not_checked sont inconnus, jamais un résultat négatif.
checkedAtstringobligatoire
Date d'enregistrement de la dernière vérification, ou null.
indexedAtstringobligatoire
Date à laquelle la page a été confirmée comme indexée, ou null. Une page confirmée comme indexée n'est pas revérifiée.
countsobjectobligatoire
Les pages, comptées par statut.
totalintegerobligatoire
Pages de fiche en ligne.
indexedintegerobligatoire
Pages affichées dans la recherche Google.
notIndexedintegerobligatoire
Pages dont le résultat enregistré est « non indexée ».
pendingintegerobligatoire
Pages en attente d'un résultat. Inconnu, jamais un résultat négatif.
notCheckedintegerobligatoire
Pages sans résultat exploitable pour l'instant. Inconnu, jamais un résultat négatif.
latestEvidenceAtstringobligatoire
Date d'enregistrement de la vérification ou confirmation la plus récente sur les pages, ou null. Peut être une date de confirmation sans nouvelle vérification.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/seo/citation-index
Votre clé API
locationId *
clientId
from
to
{
"data": {
"available": true,
"current": {
"percentage": 90.48,
"listings": 42,
"indexed": 38
},
"previous": {
"percentage": 83.33,
"listings": 42,
"indexed": 35
}
}
}