domains

POST /v1/domains/{domainId}/seo-metrics/refresh

Fetch a fresh SEO authority reading for a domain.

Все эндпоинты domains

Аутентификация

Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.

Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.

Попробовать

Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.

curl -X POST https://api.zinndigital.com/v1/domains/{domainId}/seo-metrics/refresh \
  -H "Authorization: Bearer zdk_live_…"

Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли

Подробнее

Calls the upstream provider and stores a new snapshot, then returns it in the same shape as the GET. **Consumes provider allowance on every call**, so it is driven by an explicit user action or a scheduled sweep — never by rendering a page. Returns 503 when the provider is unreachable, unconfigured, or the allowance is exhausted; in every one of those cases the previously stored reading is left untouched and still served by the GET.

Параметры

ИмяТипОбязательноЧто это
domainId (path)UuidДаThe domain's id.

Ответ

ИмяТипОбязательноЧто это
fqdnstringДа
statestring<measured, not_in_index, never_fetched>Да`measured` — the provider returned figures (which may be zero, a real measurement). `not_in_index` — the provider answered and has never crawled this domain. `never_fetched` — n…
measured_atstringНетWhen the stored reading was taken. Null when never fetched.
is_stalebooleanДаTrue when the reading is older than the 24h refresh window, or absent entirely. A hint that a refresh is worth its allowance — not an indication the figures are wrong.
metricsSeoAuthorityMetricsНет

Ошибки, которые может возвращать этот эндпоинт

401 · 403 · 404 · 429 · 503