PushizoDocs
API reference

Organization

Organization — 1 operations (GET /v1/organization/usage). Generated from the OpenAPI 3.1.0 contract.

Organization profile, members, audit log and usage/quota report. Requires an org-wide admin key.

Base URL: https://api.pushizo.com · Tag: organization · Interactive docs (Scalar)

Operations

MethodPathOperation
GET/v1/organization/usageOrganization usage and plan quotas (org-wide key)

Details

Organization usage and plan quotas (org-wide key)

Authentication: API key — scope analytics:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
daysqueryintegerNoDefault: 30; Range: 7–907

Responses

200 — Success.

Schema: UsageReport

FieldTypeRequiredDescription
org_idstringYes
plan_codestringYes
periodobjectYes
period.startstringYes
period.endstringYes
metricsarray<object>Yes
metrics[].metricstringYes
metrics[].usednumberYes
metrics[].limitnumber | nullYes
metrics[].percentnumber | nullYes
metrics[].hardbooleanYes
appsarray<object>Yes
apps[].app_idstringYes
apps[].namestringYes
apps[].messages_sentnumberYes
apps[].active_subscriptionsnumberYes
apps[].maunumberYes
dailyarray<object>Yes
daily[].datestringYes
daily[].messages_sentnumberYes
daily[].api_requestsnumberYes
daily[].events_ingestednumberYes
trialingbooleanYes
trial_ends_atstring | nullYes
overageobject | nullNo

Example response:

{
  "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",
  "overage": {
    "lines": [
      {
        "metric": "örnek",
        "included": 1.5,
        "used": 1.5,
        "billable": 1.5,
        "amounts": {
          "USD": 1.5,
          "TRY": 1.5
        }
      }
    ],
    "totals": {
      "USD": 1.5,
      "TRY": 1.5
    }
  }
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

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

On this page