Skip to content

Channel entity overview (topology + deliverability + activity)

Read-only visualization payload. Deliverability rates here are APPROXIMATE (aggregated across the channel’s from-address domains, which may be shared).

projectId
required
string

Tenant project id (row-level isolation on every query).

providerId
required
string

Email provider (channel) id.

window
string
Allowed values: 7 7d 30 30d

Rolling window; only 7 vs 30 days are honored (other values → 30).

Provider overview (header, graph, sendSeries, deliverySeries, deliverability, recentActivity).

Media typeapplication/json
object
key
additional properties
any

Not authenticated (no valid session/principal).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Authenticated but lacks the required project role.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Resource not found (or belongs to another project — indistinguishable).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}