reseller
GET /v1/reseller/vendor-usage
What your clients drew from Zinn®'s vendor accounts this month.
Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. A kulcsnak rendelkeznie kell a(z) reseller.view jogosultsággal; az ezzel nem rendelkező kulcsok esetén a rendszer 403-as hibát ad vissza 404 helyett.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X GET https://api.zinndigital.com/v1/reseller/vendor-usage \
-H "Authorization: Bearer zdk_live_…"Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
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`.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
org_id (query) | Uuid | Nem | 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… |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
pool_enforced | boolean | Igen | 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> | Igen | — |
pool_micros | integer | Igen | — |
month_spent_micros | integer | Igen | Priced spend this calendar month. A **minimum** whenever `month_is_floor` is true. |
month_remaining_micros | integer | Igen | `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 | Igen | `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 | Igen | Billed calls this month excluded from the money total. |
should_warn | boolean | Igen | You have crossed `alert_at_bps` of your pool. |
ceiling_micros | integer | Igen | 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 | Igen | — |
org_count | integer | Igen | 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[] | Igen | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 404 · 429