hosting

GET `/v1/sites/{siteId}/usage`

Get one site's metered visits for the current billing period.

توثيقِ شناخت

ایک API کلید بطور بیر ٹوکن (bearer token) ارسال کریں۔ یہ اینڈ پوائنٹ اسپیسیفیکیشن میں کسی مخصوص اجازت کا ذکر نہیں کرتا، اس لیے فرض کرنے کے بجائے اپنی کلید کو کم از کم درکار اجازت دیں اور رسپانس چیک کریں۔

یہ اینڈ پوائنٹ کوئی آرگنائزیشن آئی ڈی نہیں لیتا۔ آپ کی کلید پہلے ہی اس آرگنائزیشن کی شناخت کرتی ہے جس سے یہ تعلق رکھتی ہے، اور اس کا جواب اسی کے مطابق محدود ہوتا ہے۔

آزمائیں

کوئی بھی چیز جو زاویہ دار قوسین میں ہو اسے اپنی اقدار سے بدلیں، اور کلیدی پلیس ہولڈر کو اپنے ڈیش بورڈ کی کسی کلید سے بدلیں۔

curl -X GET https://api.zinndigital.com/v1/sites/{siteId}/usage \
  -H "Authorization: Bearer zdk_live_…"

لاگ ان ہیں؟ آپ کے ڈیش بورڈ میں موجود API کنسول آپ کی حقیقی تنظیم کی آئی ڈی اور آپ کی اپنی کلید خود بخود پُر کر دیتا ہے، اور لائیو API پر درخواست چلاتا ہے تاکہ آپ اصل ردعمل دیکھ سکیں۔ اس اینڈ پوائنٹ کو API کنسول میں کھولیں

تفصیلات

This site's billable page views so far this billing period, alongside the organisation-wide allowance they count against. RLS-scoped to a site the caller can view (`sites.view`); an out-of-scope or unknown id is a `404`, exactly like `getSite`. **A visit is a human page view with bots excluded** (owner ruling 2026-08-11). Crawlers, automated agents, assets, redirects and error responses are all excluded, and `excludedPageViews` reports how many were — the rule is published so a customer can check it rather than take it on trust. **The organisation's totals are returned with the site's own** because a site figure cannot be read without its denominator: 40,000 views is unremarkable on Agency Growth and a chargeable overage on Starter. The allowance is granted to the plan, not to the site, and is shared across every site that plan pays for.

پیرامیٹرز

نام	قسم	لازمی	یہ کیا ہے
`siteId (path)`	`Uuid`	ہاں	Site ID (UUIDv7).

جواب

نام	قسم	لازمی	یہ کیا ہے
`period_start`	`string`	ہاں	—
`period_end`	`string`	ہاں	—
`page_views`	`integer`	ہاں	This site's billable human page views this period.
`excluded_page_views`	`integer`	ہاں	This site's page views excluded as automated.
`org_page_views`	`integer`	ہاں	Billable page views across every site on the plan.
`org_allowance`	`integer`	ہاں	The plan's allowance for this period. `-1` means unlimited.
`org_unlimited`	`boolean`	ہاں	—
`org_over_limit`	`boolean`	ہاں	Whether the plan's allowance is exceeded. The site keeps serving either way.

وہ خرابیان جو یہ اینڈ پوائنٹ واپس کر سکتا ہے

401 · 403 · 404 · 429

GET /v1/sites/{siteId}/usage