Skip to main content

SummaryResponse

cache_hitCache Hitrequired
refreshing_due_to_pillars object
anyOf
boolean
stale object

True when a stale cached record was served while a refresh runs.

anyOf
boolean
summary object

Null when there are no reactions in the window.

anyOf
categoryCategoryrequired

The audience category, or persona:<id> for a single persona.

filters object
property name*any
generated_at object
anyOf
string
grade object
anyOf
string
grade_trend object

up, down or flat.

anyOf
string
id object

Present on cached records.

anyOf
string
is_staleIs Stale
Default value: false
reaction_countReaction Count
Default value: 0
status_counts object
badBad
Default value: 0
goodGood
Default value: 0
warnWarn
Default value: 0
property name*any
summary_json objectrequired

headline, overall_sentiment, top_themes, pillar_reception, top_actions, top_risks, context, data_window.

property name*any

headline, overall_sentiment, top_themes, pillar_reception, top_actions, top_risks, context, data_window.

workspace_idWorkspace Idrequired
property name*any
property name*any
SummaryResponse
{
"cache_hit": true,
"refreshing_due_to_pillars": true,
"stale": true,
"summary": {
"category": "string",
"filters": {},
"generated_at": "string",
"grade": "B",
"grade_trend": "string",
"id": "string",
"is_stale": false,
"reaction_count": 0,
"status_counts": {
"bad": 0,
"good": 0,
"warn": 0
},
"summary_json": {},
"workspace_id": "string"
}
}