Counts (sub-partners / accounts / locations)
Overview
Get headline counts of sub-partners, accounts, and locations for the authenticated partner, each with 30-day / 90-day comparison buckets.
Prerequisites
- A bearer token. Callable with Partner tokens.
Base URL
| Environment | URL |
|---|---|
| Production | https://production-api.shoutaboutus.com |
| Development | https://development-api.shoutaboutus.com |
Endpoint
GET /api/v1/partner/stats/counts
Authentication
-
Requires a bearer token in the
Authorization: Bearer <bearer-token>header. -
Who can call it: Partner tokens.
-
Scope is the partner tree walked from the caller.
-
Sub-partners are
companyrows (bundle_id=1) directly under it. -
Accounts are
bundle_id=3 rows under the company OR under its sub-partners. Locations arebundle_id=2 rows under those account IDs. -
If the user has
assign_brandset, account/location scope is further narrowed toassignBrands.
Rate limit
- No rate limit.
Request
- No path, query, or body params (reads the authenticated user only).
Response
sub-partners.count(int) — total sub-partner companies under this partner.sub-partners.last_30_days(int) — sub-partners created in the last 30 days.sub-partners.before_30_days(int) — sub-partners created earlier than 30 days ago.accounts.count(int) — total accounts in scope.accounts.last_30_days(int) — accounts created in the last 30 days.accounts.before_30_days(int) — accounts created earlier than 30 days ago.locations.count(int) — total locations (bundle_id=2) in scope.locations.last_30_days(int) — locations created in the last 30 days.locations.before_30_days(int) — locations created earlier than 30 days ago.locations.last_90_days(int) — locations created in the last 90 days.
200 Success · 200
200{
"data": {
"sub-partners": { "count": 8, "last_30_days": 2, "before_30_days": 6 },
"accounts": { "count": 24, "last_30_days": 5, "before_30_days": 19 },
"locations": { "count": 142, "last_30_days": 12, "before_30_days": 130, "last_90_days": 30 }
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
500 | Unexpected server error |
Example request
curl --request GET \
--url "https://production-api.shoutaboutus.com/api/v1/partner/stats/counts" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 9 days ago
Did this page help you?
