reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
認証
ベアラー トークンとして API キーを送信します。キーには reseller.view 権限が付与されている必要があります。権限のないキーは 404 ではなく 403 で拒否されます。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Spend for your whole client base this calendar month, against your pool, broken down by vendor. Always read `month_is_floor` and `ceiling_is_floor` before showing a total: some vendors bill prepaid units whose per-unit cost is not priced here, so when a flag is `true` the money figure is a **minimum** and `month_unpriced_calls` counts what it excludes. `ceiling_micros` is the most your client base could draw in a month if every client used every allowance their plan includes — it does not depend on how busy this month happened to be. Available even when your pool is spent. Requires `reseller.view`.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | Uuid | いいえ | Which of your organizations this applies to. Required only when you belong to more than one here — otherwise it is inferred, and an id outside your direct memberships is a 404 r… |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
pool_enforced | boolean | はい | Read this first. `false` means no pool has been set, so nothing is bounded — it does not mean you have a large allowance remaining. |
seo_data_mode | string<own_keys, platform_pool> | はい | — |
pool_micros | integer | はい | — |
month_spent_micros | integer | はい | Priced spend this calendar month. A **minimum** whenever `month_is_floor` is true. |
month_remaining_micros | integer | はい | `null` when no pool is set, or when the month's spend is a floor — an unknown cannot be subtracted from a budget to give a remainder. |
month_is_floor | boolean | はい | `true` means `month_spent_micros` understates the truth because a vendor we cannot price per call was used. Show it beside the number. |
month_unpriced_calls | integer | はい | Billed calls this month excluded from the money total. |
should_warn | boolean | はい | You have crossed `alert_at_bps` of your pool. |
ceiling_micros | integer | はい | The most your client base could draw in a month if every client used every allowance their plan includes. Independent of how busy this month was. |
ceiling_is_floor | boolean | はい | — |
org_count | integer | はい | Organizations counted — you plus your clients. A client of yours who is themselves a reseller has their own pool and is not counted beyond themselves. |
services | ResellerVendorServiceDraw[] | はい | — |
このエンドポイントが返すエラー
401 · 403 · 404 · 429