Synup
Créer une clé
v1Ressources/SEO/getRead saved volumes measurement

Read saved volumes measurement

Read the request in the current agency/client scope. Never purchases a measurement.

get/api/v1/seo/website-keywords/volumes
seo:read
Paramètres de requête
locationIdstringobligatoire
requestIdstringobligatoire
Réponse
dataobjectfacultatif
requestIdstringfacultatif
statusstring (pending | ready | partial | failed | unknown)facultatif
keywordsarray of stringfacultatif
estimatedCreditsnumberfacultatif
recordedCreditsnumberfacultatif
Known ledger credits after settlement, with internal/staging exemption applied. Null for unknown or unsettled outcomes; never infer provider USD from credits.
settlementstring (pending | settled | unknown)facultatif
generatedAtstringfacultatif
Record update time; use each observation timestamp for measurement age.
stepsarray of objectfacultatif
Join keywords against results and steps. Failed or skipped measurements have no result; absence is not zero volume or outside-depth ranking.
keywordsarray of stringfacultatif
statusstring (queued | submitting | ready | failed | skipped | unknown)facultatif
deliveredbooleanfacultatif
closeVariantsMayShareVolumebooleanfacultatif
volumesAreAdditivebooleanfacultatif
keywordMatchingstring (trim_whitespace_case_only)facultatif
volumeDefinitionstring (average_monthly_searches)facultatif
dataMonthDefinitionstring (latest_monthly_series_entry)facultatif
resultsarray of objectfacultatif
callerKeywordstringfacultatif
providerKeywordstringfacultatif
collectedAtstringfacultatif
statusstring (measured | no_data | omitted | unsupported)facultatif
volumenumberfacultatif
Average monthly estimate; measured zero is different from null.
dataMonthstringfacultatif
Newest monthlySearches entry, not the single-month basis of volume.
monthlySearchesarray of objectfacultatif
yearintegerfacultatif
monthintegerfacultatif
volumenumberfacultatif
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.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409Request identity mismatch, concurrent request or pending/unknown research hold.
422A valid website or adequate maxEstimatedCredits is required.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
503Measurement or durable credit settlement unavailable. Preserve the requestId and read saved status before retrying.
get/api/v1/seo/website-keywords/volumes
Votre clé API
locationId *
requestId *
{}

Guides qui utilisent cette ressource