Skip to main content
GET
/
v1
/
organization
/
stats
/
{appId}
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/stats/{appId} \
  --header 'Authorization: Bearer <token>'
{
  "messagesSent": 12543,
  "messagesThisMonth": 573,
  "successRate": 98.5,
  "activeWebhooks": 4
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

​
appId
string
required

Unique identifier for a App. Format: app_[test_]{ksuid}

Pattern: ^app_(?:test_)?[a-zA-Z0-9]{27}$
Example:

"app_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

App dashboard statistics

​
messagesSent
number
required

Total number of outbound messages sent

Example:

12543

​
messagesThisMonth
number
required

Number of messages sent this month

Example:

573

​
successRate
number
required

Percentage of successfully delivered messages (0-100)

Example:

98.5

​
activeWebhooks
number
required

Number of active webhooks configured for the app

Example:

4