Usage

GET /v1/tenant/usage

Counts the production events your tenant created in a period, by delivery channel, and returns the allowances of your plan. Sandbox events are never counted.

Authentication

Any API key or session token of your tenant. No specific permission is required. The result is always production usage, whichever key you use.

Query parameters

string

required

Start of the period, ISO 8601 date-time (inclusive), for example 2026-09-01T00:00:00Z.

string

required

End of the period, ISO 8601 date-time (inclusive), for example 2026-09-30T23:59:59Z.

Events are counted by the time wede received them (created_at).

Example

curl "https://api.wede.pt/v1/tenant/usage?from=2026-09-01T00:00:00Z&to=2026-09-30T23:59:59Z" \
  -H "x-wede-api-key: wede_live_YOUR_KEY"

Response

200 OK

{
  "tenant_id": "9eb65ffa-3c1d-4d7e-8f02-1a2b3c4d5e6f",
  "period": { "from": "2026-09-01T00:00:00Z", "to": "2026-09-30T23:59:59Z" },
  "totals": {
    "events": 12450,
    "offline_events": 830,
    "sms_messages": 214,
    "voice_calls": 9
  },
  "limits": {
    "max_events_per_year": 1000000,
    "included_sms": 5000,
    "included_voice_min": 500,
    "included_data_kb": 0,
    "included_lora": 0,
    "included_satellite": 0,
    "included_edge": 0
  },
  "by_channel": {
    "rest_full": 12020,
    "sms": 214,
    "voice": 9,
    "lora": 0,
    "satellite": 0,
    "edge": 0
  }
}

Values in this example are illustrative.

string

Your tenant ID.

object

The from and to you sent.

object

Show properties

integer

All production events received in the period.

integer

Events captured offline and received through sync.

integer

Events delivered by SMS.

integer

Events delivered by voice.

object

Allowances of your plan in your country. 0 when your plan does not include that item or no plan is assigned.

Show properties

integer

Events included per year.

integer

SMS messages included.

integer

Voice minutes included.

integer

Data included, in KB.

integer

LoRa messages included.

integer

Satellite messages included.

integer

Edge messages included.

object

Events in the period by delivery channel (channel_used): rest_full, sms, voice, lora, satellite, edge. Events on other paths (rest_compressed, queued_offline) or not yet processed count in totals.events only.

For your year-to-date consumption against your plan, see Billing.

Errors

Status	Code	When
400	`invalid_payload`	`from` or `to` is missing
401	`unauthorized`	Credential missing, malformed, revoked or expired
503	`service_unavailable`	The API key could not be validated right now. Retry

Overview

Authentication

Events

Teams & Dispatch

Missions

Zones

Billing

Tenant

Webhooks

Sync

Connectivity

Sandbox

Parsers

Onboarding

Authentication

Query parameters

Example

Response

Errors

​Authentication

​Query parameters

​Example

​Response

​Errors

Authentication

Query parameters

Example

Response

Errors