Skip to navigation

List the Accepted Research Snippet Types

View as Markdown

Lists the recognized research snippet types. A textType in this list is validated against its length and paragraph rules on write and defaults to visible; a textType not in this list is still saved but defaults to visible=false (hidden from default reads). The per-row visible flag overrides the default either way. The curated and analysisRenderable flags mark public Analysis-page eligibility, not snippet display.

Response headers

X-RateLimit-LimitintegerOptional

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-RemainingintegerOptional

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-ResetintegerOptional

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

OK
analysisRenderableboolean
Whether curated rows of this snippet type can make the public company Analysis page eligible.
appliesToTypelist of enums

Entity types for which this snippet is meaningful; empty means every type.

curatedboolean

Whether the type is curated; with analysisRenderable this gates public Analysis-page eligibility. It does not gate snippet display — every type listed here is recognized and defaults to visible, and the row-level visible flag controls display.

defaultVisibleboolean

Default visible flag when a write omits visible; true for recognized snippet types even when curated=false.

labelstring

Human-readable label.

readerQuestionstring

One reader-facing question the analysis answers, shown where readers choose an analysis.

recognizedboolean

Whether aVenture recognizes this text type; true for every row this endpoint returns.

targetPathstring
Dotted research section path the snippet attaches to.
typeValuestring
Snippet type value used in requests and responses.
writeHintstring

The strategic question this snippet type answers and how to shape it. Snippets are point-in-time strategic analysis of the company’s position against its market and named alternatives: open with the judgment and give dated details only as evidence for it, never as a fact list.

analysisSectionLabellist of stringsOptional

Ordered headings for the fixed paragraphs of a framework analysis. Empty means ordinary prose; preserve legacy prose when its paragraph count differs.

minLengthinteger or nullOptional

Minimum total text length in characters; null = no minimum.

paragraphShapeobject or nullOptional

Per-paragraph shape rule that write requests must satisfy; null = no paragraph rule.

Errors

400
Bad Request Error
406
Not Acceptable Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error