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/api/v1/seo/citation-index

seo:read

Paramè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.

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.

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
    }
  }
}