hosting
GET /v1/index-monitoring
What this organisation monitors for search indexing, and what it may add.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
Both paid indexing allowances, and every target being monitored, in one call. There are **three** indexing positions and only two of them have a row here. A site hosted with us has its whole-site check included free on every plan and appears in no list — that is what makes it free rather than discounted, and it is why `sections.used` can be `0` on an account that is checking fifty sites. A `section` target is a page or path prefix within a site, on top of that free check. An `external_site` target is a whole website hosted somewhere else, billed monthly per site. ⛔ Each allowance is returned with its **denominator** as well as its remainder. A bare "3 remaining" reads identically on an account with an allowance of 3 and nothing used, and on one with an allowance of 100 — and a client that renders only the remainder cannot tell a customer whether buying more would help. ⛔ `indexed` on a target is **three-valued**. `false` means the provider answered and does not list the page; `null` means no reading exists yet, or the row is beyond the current allowance and the sweep is not checking it. A client that renders `null` as `false` reports a customer's pages as deindexed on the morning their card expires. `monitored` is the field that says which of those two a `null` is. Never calls the upstream provider, so it is free to render and poll.
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
daily | boolean | Да | Checks run daily rather than weekly. |
daily_from_plan | boolean | Да | The daily cadence came from the plan rather than a standalone add-on. ⭐ An upsell surface reads this to say "included in your plan" instead of offering to sell something the cus… |
sections | IndexMonitoringAllowance | Да | One counted allowance, always with its denominator. ⛔ `remaining` alone is not renderable: it reads the same on an allowance of 3 with nothing used as on an allowance of 100 wit… |
external_sites | IndexMonitoringAllowance | Да | One counted allowance, always with its denominator. ⛔ `remaining` alone is not renderable: it reads the same on an allowance of 3 with nothing used as on an allowance of 100 wit… |
targets | IndexMonitoringTarget[] | Да | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404