Skip to content
Pidgely Docs

API reference · Native API (v1)

Platform metrics for the watcher (bearer token)

GEThttps://api.pidgely.com/v1/platform/watch/metrics
View as Markdown

Read-only platform numbers (accounts, sending, errors, revenue; platform team only), same as GET /v1/platform/metrics, for the company watcher. No API key: a bearer secret whose SHA-256 is PLATFORM_WATCH_TOKEN_SHA256; 404 while that variable is empty.

Request

cURL
curl -X GET 'https://api.pidgely.com/v1/platform/watch/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.