hosting
GET /v1/sites/{siteId}/seo-settings
How often this site's SEO metrics are checked, and what is shown.
المصادقة
أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.
لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.
جربه الآن
استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.
curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/seo-settings \
-H "Authorization: Bearer zdk_live_…"هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم API
التفاصيل
The schedule this site is checked on, which providers are asked, which metrics are rendered, and — importantly — **who is paying** for the checks. `funding` is the field to read before showing anything else. `own_key` means the checks run on a key you connected, against your own quota, and cost nothing here. `platform` means they run on Zinn®'s own accounts under your plan or add-on. `none` means no check can currently run, and `reason` says what to do about it. A site that has never been configured answers with the account defaults rather than 404 — there is nothing to create before this can be read.
المعلمات
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
siteId (path) | Uuid | نعم | Site ID (UUIDv7). |
الاستجابة
| الاسم | النوع | مطلوب | ما هو هذا |
|---|---|---|---|
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