hosting
GET /v1/index-monitoring
What this organisation monitors for search indexing, and what it may add.
Xác thực
Gửi khóa API dưới dạng mã thông báo bearer. Điểm cuối này không nêu rõ quyền cụ thể trong thông số kỹ thuật, vì vậy hãy cấp cho khóa của bạn quyền tối thiểu cần thiết và kiểm tra phản hồi thay vì phỏng đoán.
Endpoint này không nhận ID tổ chức. Khóa của bạn đã xác định tổ chức mà nó thuộc về và phản hồi được giới hạn trong phạm vi đó.
Dùng thử
Thay thế bất kỳ nội dung nào trong ngoعل (angle brackets) bằng giá trị của riêng bạn và trình giữ chỗ key bằng một key từ trang tổng quan của bạn.
curl -X GET https://api.zinndigital.com/v1/index-monitoring \
-H "Authorization: Bearer zdk_live_…"Đã đăng nhập? Bảng điều khiển API trong trang quản lý của bạn sẽ tự điền ID tổ chức thực tế và khóa của riêng bạn, sau đó chạy yêu cầu đối với API trực tiếp để bạn có thể xem phản hồi thực tế. Mở điểm cuối này trong bảng điều khiển API
Chi tiết
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.
Phản hồi
| Tên | Loại | Bắt buộc | Nội dung này là gì |
|---|---|---|---|
daily | boolean | Có | Checks run daily rather than weekly. |
daily_from_plan | boolean | Có | 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… |
sections | IndexMonitoringAllowance | Có | 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 with… |
external_sites | IndexMonitoringAllowance | Có | 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 with… |
targets | IndexMonitoringTarget[] | Có | — |
Các lỗi điểm cuối này có thể trả về
401 · 403 · 404