Sample comments behind a post analysis

Requires `comments:read` and `posts:read`. A **sample of comments behind** `GET /posts/{postId}/analysis` — the evidence for the mix bars, content topics, and messages. Hidden comments are excluded. Siftsy is an analysis platform, not a comment exporter. Do not use this route to dump a full comment section. Prefer `source=notables` (engagement + relevance), `content` (grouped onto creator topics/messages), or `all` (union). Sampled rows include `sampleReasons`. `meta.groups` always lists content topic and message membership. Narrow the sample with mix-bar buckets (`sentiment`, `content`, `topic`, `relevance`, `consensus`). Repeat a parameter or comma-separate to OR values within a dimension; different dimensions combine with AND. Rate class `comments` (120 / minute, 1,000 / day per key) — enough to sample every post in a 500-post workspace once a day.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
X-Api-Keystring
API Key authentication via header

Path parameters

postIdstringRequired

Query parameters

cursorstringOptional
limitintegerOptional1-100Defaults to 25
sourceenumOptional

How to sample comments behind this analysis. Prefer notables (engagement + relevance), content (grouped onto creator topics/messages), or all (union). This is evidence, not a full-thread export.

Allowed values:
sentimentstringOptional
Only comments whose overall sentiment falls in these mix-bar buckets. Comma-separate or repeat to match several (`positive,lean_positive`). Values: `positive`, `lean_positive`, `neutral`, `lean_negative`, `negative`. Score version 3 uses a five-bucket split (neutral is 4.5–5.5); v1/v2 have no unused middle band.
contentstringOptional

Only comments whose content sentiment (alignment with the post / creator) falls in these buckets. Same keys as sentiment. Score version 2+ comments; unscored comments are excluded.

topicstringOptional

Only comments whose topic sentiment (reception of the subject) falls in these buckets. Same keys as sentiment.

relevancestringOptional
Only comments in these relevance mix-bar buckets. Canonical keys match metrics (`positive`, `lean_positive`, `neutral`, `lean_negative`, `negative`). Dashboard labels also work: `on_topic`, `relevant`, `general`, `off_topic`.
consensusstringOptional

Only comments in these consensus mix-bar buckets. Canonical keys match metrics. Dashboard labels also work: agreeing, discussing, debating, fighting. Consensus is how the commenter is reacting to other commenters, not to the post.

Response

Sample of comments behind this analysis
datalist of objectsOptional
metaobjectOptional

Errors

400
Bad Request Error
404
Not Found Error