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

Read saved serp measurement

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

get/api/v1/seo/website-keywords/serp
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
deviceMetadataSourcestring (request_echo)facultatif
positionBasisstring (organic_rank_group)facultatif
featureCoveragestring (positive_observations_only)facultatif
resultsarray of objectfacultatif
callerKeywordstringfacultatif
providerKeywordstringfacultatif
collectedAtstringfacultatif
statusstring (found | not_found | incomplete | no_results)facultatif
completebooleanfacultatif
observedDepthintegerfacultatif
completedDepthintegerfacultatif
requestedobjectfacultatif
observedobjectfacultatif
locationCodenumberfacultatif
languagestringfacultatif
devicestringfacultatif
Provider request echo, not independent device verification.
enginestringfacultatif
checkedAtstringfacultatif
ownedResultsarray of objectfacultatif
All observed owned organic URLs in requested scope. Position is organic rank_group, not absolute SERP slot. A positive found observation may be partial; absence requires complete depth.
firstPageResultsarray of objectfacultatif
firstPageFeaturesarray of stringfacultatif
Positive bounded feature-type sample only. Missing types do not establish absence. Uses page=1, or absolute slot <=10 only when page is missing.
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/serp
Votre clé API
locationId *
requestId *
{}

Guides qui utilisent cette ressource