SynqDocs
Management APIBrands

Read a brand's numbers

A brand at a glance: its users, its monthly active users this month (the count the org's usage adds up toward its plan), its sign-ins started and finished and its new users over the last 7 days in UTC (finished over started is its sign-in success), and how many people signed in through each of its apps this month. Sign-ins through Synq's sign-in preview are a developer trying the page, and count in none of them. Needs `org.brands.view`.

GET/v1/orgs/{org}/brands/{brand}/stats

A brand at a glance: its users, its monthly active users this month (the count the org's usage adds up toward its plan), its sign-ins started and finished and its new users over the last 7 days in UTC (finished over started is its sign-in success), and how many people signed in through each of its apps this month. Sign-ins through Synq's sign-in preview are a developer trying the page, and count in none of them. Needs org.brands.view.

Authorization

bearer
AuthorizationBearer <token>

An org API key (sk_live_…, sk_test_…), or an access token from the Synq issuer (the synq brand, on the accounts host) for this API.

In: header

Path Parameters

org*string

The org's id

Match^org_[0-9a-hjkmnp-tv-z]{26}$
brand*string

The brand's id

Match^brd_[0-9a-hjkmnp-tv-z]{26}$

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://api.synq.build/v1/orgs/org_01h455vb4pex5vsknk084sn02q/brands/brd_01h455vb4pex5vsknk084sn02q/stats" \  -H "Authorization: Bearer $SYNQ_API_KEY"
{  "brand_id": "brd_01h455vb4pex5vsknk084sn02q",  "month": "2026-11",  "users": 1280,  "monthly_active_users": 312,  "sign_ins_last_7_days": 940,  "sign_ins_started_last_7_days": 1010,  "new_users_last_7_days": 48,  "apps": [    {      "app_id": "app_01h455vb4pex5vsknk084sn02q",      "users_signed_in": 120    }  ]}