Skip to content

Get Trial Overview

GET
/accounts/trial-overview

Headline trial numbers for your own organisation.

Carries an honest data_availability map: a block whose source table is not populated reports that it has no data rather than a misleading zero. Read it before treating any number here as a fact.

Always your own tenant. The app’s cross-tenant scope=platform branch is graph8-staff tooling and is not reachable through this API.

Authorizations

Parameters

Query Parameters

view

Count trials by company or by contact.

string
default: companies /^(companies|contacts)$/

Count trials by company or by contact.

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