Skip to main content
GET
Inspect one theme or topic

Authorizations

Authorization
string
header
required

Your organization API key. Paste the key itself — the "Bearer " prefix is added for you.

Headers

X-Acting-User
string

Run the request as this organization member (user id or email). Omit to run as the organization. A value that is not a member returns 403.

Path Parameters

id
string
required

Theme id, topic id, or "none" for unassigned themes at level topics. Merged theme ids resolve to the current theme.

Required string length: 1 - 80

Query Parameters

level
enum<string>
default:themes

themes: specific recurring subjects; topics: broad areas grouping themes.

Available options:
themes,
topics
days
enum<integer>
default:30

Window ending today, compared with the equal window just before. Not with from/to.

Available options:
7,
30,
90,
365
from
string<date>

Custom window start (YYYY-MM-DD); needs to, at most 366 days, not with days.

to
string<date>

Custom window end (YYYY-MM-DD, inclusive); needs from.

sources
enum<string>[]

Count only observations from these source groups. Comma-separated or repeated; empty is no filter.

Available options:
calls,
emails,
slack,
documents
types
enum<string>[]

Themes holding any of these observation types. Comma-separated or repeated.

Available options:
questions,
discovery,
pain,
risk,
objection,
product_request,
requirement,
pricing_signal,
timeline,
urgency,
commitment,
buying_intent,
product_information,
commercial_information,
implementation_information,
stakeholder_signal,
competitor_signal,
risk_resolution,
seller_intent,
coaching,
background,
summary
families
enum<string>[]

Themes holding any type of these families. With types, only the types in both count. Comma-separated or repeated.

Available options:
voice,
health,
commercial,
context,
craft
deal_id
string<uuid>

Themes level only. Select themes raised on this deal in the window; counts stay organization-wide.

include
enum<string>[]

Sections to expand. Themes: topic, definition, examples, related, timeline, observations, deals, accounts, artifacts. Topics: themes, timeline, observations, deals, accounts, artifacts. Comma-separated or repeated.

Available options:
topic,
definition,
examples,
related,
timeline,
observations,
deals,
artifacts,
accounts,
themes
granularity
enum<string>

Requires include=timeline. Default day up to 14 days, week up to about a quarter, month beyond. day supports at most 92 days; at most 150 buckets per call.

Available options:
day,
week,
month
evidence_limit
integer
default:10

Rows per included evidence kind. Total evidence budget is 60 rows; examples have at most 8.

Required range: 1 <= x <= 50
evidence_cursor
string

Continue one evidence page. Include exactly one of observations, deals, accounts or artifacts.

Maximum string length: 64

Response

Theme or topic returned.

comparison
enum<string>
required

unavailable: one window had too few active accounts to compare, so growth is null and nothing is escalating or declining.

Available options:
ok,
unavailable
evidence_scope
enum<string>
required

your_deals: counts and rows stay organization-wide, but evidence comes only from deals the principal can access.

Available options:
organization,
your_deals
availability
enum<string>
required

hidden: Themes is not enabled for the organization; unpublished: none built yet.

Available options:
ready,
hidden,
unpublished
period
object
required
analyzed_account_count
integer
required
previous_analyzed_account_count
integer
required
analyzed_artifact_count
integer
required
previous_analyzed_artifact_count
integer
required
analyzed_deal_count
integer
required
themes_through
string | null
required

Day of the newest observation grouped into a theme, within the long-term range: where theme data ends.

level
enum<string>
required
Available options:
themes,
topics

Present only with query.

computed_at
string<date-time>

When these counts were computed (UTC). The first page of a list without query or deal_id can be up to six hours old; later pages, searches, deal_id lists, and single theme or topic reads are computed for the call.

theme
object | null

Present only at level themes. Null while Themes is hidden or unpublished.

topic
object | null

Present only at level topics. Null while unavailable or topic grouping is disabled.

enabled
boolean

Topics level only: whether topic grouping is enabled.