aVenture APIEntity Research

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-Limitinteger

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

X-RateLimit-Remaininginteger

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

X-RateLimit-Resetinteger

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.
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.

recognizedboolean

Whether this textType is recognized by the research contract catalog; true for every row returned by this endpoint.

targetPathstring
Dotted research section path the snippet attaches to.
typeValuestring
Canonical snippet type token used on the wire.
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