hosting
PUT /v1/sites/{siteId}/seo-settings
Choose the schedule, providers and visible metrics for this site.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X PUT https://api.zinndigital.com/v1/sites/{siteId}/seo-settings \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ }'ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Sets how often this site is checked, which of your connected providers to ask, and which metrics to display. Checks may not be scheduled more often than every 12 hours. Hiding a metric changes only what is rendered — the reading is still taken and its history is kept, so turning it back on shows the full series rather than starting from today.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
siteId (path) | Uuid | はい | Site ID (UUIDv7). |
リクエスト本文
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
cadence | string<daily, every_other_day, weekly> | いいえ | — |
providers | string[] | いいえ | — |
visible_metrics | string[] | いいえ | — |
paused | boolean | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
cadence | string<daily, every_other_day, weekly> | はい | How often this site is checked. Checks may not run more often than every 12 hours. |
providers | string[] | はい | Which providers to ask, by name. Empty means "whichever of my connected keys can answer", which is the sensible setting for an account with one key. |
visible_metrics | string[] | はい | Which metrics to render for this site. Empty means show everything available. A display choice only — hidden metrics are still measured and their history kept. |
available_metrics | string[] | はい | Every metric the currently-funded provider can supply for this site. The set a client should offer as toggles; a metric outside it cannot be shown however it is configured, beca… |
paused | boolean | はい | When true nothing is checked and nothing is spent. History is kept, and settings are restored untouched when it is switched back on. |
funding | string<own_key, platform, none> | はい | Who pays for this site's checks. `own_key` — your own connected key and your own quota, free here. `platform` — Zinn®'s accounts, under your plan or add-on. `none` — nothing can… |
vendor | string | いいえ | The provider actually serving this site, when one is. |
reason | string<no_key_connected, own_key_unusable, reseller_addon_required, not_entitled, not_in_good_standing> | いいえ | Why no check can run, when `funding` is `none`. `own_key_unusable` means a key is stored but could not be used — usually revoked or out of quota at the provider, and Zinn® delib… |
このエンドポイントが返すエラー
401 · 403 · 404 · 422