PushizoDocs
API referansı

Organizasyon

Organizasyon — 1 işlem (GET /v1/organization/usage). OpenAPI 3.1.0 sözleşmesinden üretilir.

Organizasyon profili, üyeler, denetim kaydı ve kullanım/kota raporu. Org geneli admin anahtarı gerekir.

Taban adres: https://api.pushizo.com · Etiket: organization · Etkileşimli belge (Scalar)

İşlemler

YöntemYolİşlem
GET/v1/organization/usageOrganizasyon kullanımı ve plan kotaları (org geneli anahtar)

Ayrıntılar

Organizasyon kullanımı ve plan kotaları (org geneli anahtar)

Kimlik doğrulama: API anahtarı — kapsam analytics:read (admin her kapsamı içerir).

Parametreler

AdKonumTürZorunluAçıklamaÖrnek
dayssorguintegerHayırVarsayılan: 30; Aralık: 7–907

Yanıtlar

200 — Başarılı.

Şema: UsageReport

AlanTürZorunluAçıklama
org_idstringEvet
plan_codestringEvet
periodobjectEvet
period.startstringEvet
period.endstringEvet
metricsarray<object>Evet
metrics[].metricstringEvet
metrics[].usednumberEvet
metrics[].limitnumber | nullEvet
metrics[].percentnumber | nullEvet
metrics[].hardbooleanEvet
appsarray<object>Evet
apps[].app_idstringEvet
apps[].namestringEvet
apps[].messages_sentnumberEvet
apps[].active_subscriptionsnumberEvet
apps[].maunumberEvet
dailyarray<object>Evet
daily[].datestringEvet
daily[].messages_sentnumberEvet
daily[].api_requestsnumberEvet
daily[].events_ingestednumberEvet
trialingbooleanEvet
trial_ends_atstring | nullEvet

Örnek yanıt:

{
  "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "plan_code": "örnek",
  "period": {
    "start": "2026-10-01T00:00:00Z",
    "end": "2026-10-17T00:00:00Z"
  },
  "metrics": [
    {
      "metric": "örnek",
      "used": 1.5,
      "limit": 50,
      "percent": 1.5,
      "hard": true
    }
  ],
  "apps": [
    {
      "name": "Sipariş bildirimleri",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "messages_sent": 1.5,
      "active_subscriptions": 1.5,
      "mau": 1.5
    }
  ],
  "daily": [
    {
      "date": "örnek",
      "messages_sent": 1.5,
      "api_requests": 1.5,
      "events_ingested": 1.5
    }
  ],
  "trialing": true,
  "trial_ends_at": "örnek"
}

Hata yanıtları ortak zarfla döner (error.code, message, details, request_id): hata kataloğu. Tüm yanıtlar X-RateLimit-* başlıklarını taşır (hız sınırları).

Örnekler

curl -X GET "https://api.pushizo.com/v1/organization/usage" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Bu sayfada