hosting
GET /v1/index-monitoring
What this organisation monitors for search indexing, and what it may add.
Pagpapatotoo
Magpadala ng API key bilang bearer token. Ang endpoint na ito ay hindi naglatag ng tiyak na pahintulot sa pagtutukoy, kaya ibigay sa iyong key ang pinakamababang kailangan nito at suriin ang tugon sa halip na umasa.
Ang endpoint na ito ay hindi nangangailangan ng id ng organisasyon. Natutukoy na ng iyong key ang organisasyong kinabibilangan nito, at nakatuon ang tugon dito.
Subukan ito
Palitan ang anuman sa loob ng mga panaklong na may anggulo ng iyong sariling mga halaga, at ang placeholder ng key na may key mula sa iyong dashboard.
curl -X GET https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…"Nakalagda? Ang API console sa iyong dashboard ay awtomatikong naglalagay ng iyong tunay na ID ng organisasyon at sariling susi, at pinapatakbo ang kahilingan laban sa live na API upang makita mo ang aktwal na tugon. Buksan ang endpoint na ito sa console ng API
Mga Detalye
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.
Tugon
| Pangalan | Uri | Kailangan | Ano ito |
|---|---|---|---|
daily | boolean | Oo | Checks run daily rather than weekly. |
daily_from_plan | boolean | Oo | 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 | Oo | 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 | Oo | 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[] | Oo | — |
Mga error na maibabalik ng endpoint na ito
401 · 403 · 404