API reference · Native API (v1)
Platform numbers panel (platform team only)
GET
https://api.pidgely.com/v1/platform/metricsRead-only numbers for the platform team: accounts created and active, sending volume and rates (UTC days: 24h = today, 7d = today plus six days), top 10 accounts, errors, queue and recurring revenue. Fields the platform does not record are the string "não medido". Needs a full API key of the platform organisation or of one with an operator member; any other key gets 403.
Authorization: Bearer pdg_…. An API key with the full scope.
Request
curl -X GET 'https://api.pidgely.com/v1/platform/metrics' \
-H "Authorization: Bearer $PIDGELY_API_KEY"Response
200 OK with a JSON object.
Errors
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 Free plan quota is used up. |