Skip to navigation

Search observations

Returns the observations that match the criteria, largest first. Results aren’t paginated, so narrow them with query, theme_id or filters.

Authentication

AuthorizationBearer

Your Chattermill API key, from Settings > API in the Chattermill app.

Path parameters

projectstringRequired

Your project’s key, from List projects.

Request

Observation search parameters
querystringOptional
Text query to search observations
theme_idintegerOptional
Theme ID to filter observations by
limitintegerOptional

Maximum number of observations to return (1-100, default 20)

snippets_per_observationintegerOptional

Number of feedback snippets per observation (1-20, default 10)

filterslist of objectsOptional
Additional filters to apply

Response

Observation search results
metaobjectOptional

Total matching observations. relation is gte when the search reached its 500-observation cap, so more observations may match.

observationslist of objectsOptional

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error