Skip to content

Get Brand Summary

GET
/api/v1/agency/brands/{brand_id}

Per-brand summary for the agency dashboard.

Authorizations

Parameters

Path Parameters

brand_id
required
string format: uuid

Responses

200

Successful Response

Per-brand summary for agency drill-down.

object
avg_health
number
brand_id
required
string format: uuid
brand_name
required
string
domain_status
string
default: not_configured
email_status
string
default: not_configured
mrr
number
tenant_count
integer

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string