Skip to content

Get Trial Insight

POST
/accounts/{account_id}/trial-insight

Why this trial is stalling, and the next thing to try.

POST only because it is rate-limited per caller and bounded work, NOT because it changes anything: it is rule-based, spends no credits, sends nothing and writes nothing. It is classified read-only for exactly that reason, so a read-only key can call it - which matters, because it is the diagnosis you want before touching a customer.

429 when the hourly budget is exhausted.

Authorizations

Parameters

Path Parameters

account_id
required

Account id: the account UUID or the company id.

string

Account id: the account UUID or the company id.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a single role, team, member or account record.

Open on purpose. The app’s own response models on this surface grow with the product - RoleResponse gained rep_limits and manages_role_slugs, TeamResponse gained channel counts and a campaign count - and a pinned mirror would SILENTLY DROP whatever it had not caught up on. A dropped permission in a role read is the worst possible kind of stale: it reads as “they do not have it”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

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