API reference · Native API (v1)

Retrieve usage

GEThttps://api.pidgely.com/v1/usage

Returns today's counters (UTC day), the daily quota and the account status.

Authorization: Bearer pdg_…. An API key with the full scope.

Request

cURL

curl -X GET 'https://api.pidgely.com/v1/usage' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

200 OK

JSON

{
  "today": {
    "accepted": 1520,
    "delivered": 1498,
    "bounced": 6,
    "complained": 0
  },
  "daily_quota": 500,
  "status": "sandbox"
}

Name	Type	Required	Description
`today`	object	No	—
`today.accepted`	integer	No	—
`today.delivered`	integer	No	—
`today.bounced`	integer	No	—
`today.complained`	integer	No	—
`daily_quota`	integer	No	—
`status`	string	No	Current status.

Native routes return {"error": {"code", "message", "field", "request_id"}}. See Errors.

Status	Code	When
401	`missing_api_key`	No `Authorization: Bearer` header.
403	`invalid_api_key`, `insufficient_scope`	The key is invalid or lacks the scope.
404	`not_found`	The resource does not exist in this account.
422	`validation_error`	A field is missing or invalid; `field` names it.
429	`rate_limited`, `daily_quota_exceeded`	Too many requests, or the quota is used up.