Appearance
Posts endpoints
Reference for the /post endpoint family in API V2.
What is a post?
A post is a collected content item ingested by a job and stored inside a project. Posts come from monitored platforms and carry fields such as text content, author, publication timestamp, platform code, engagement metrics, sentiment, priority, and assigned tags.
Capabilities
This endpoint family covers:
- Search and count — filter posts using date ranges, platforms, sentiment, priority, jobs, tags, language, author, and text search
- Export — download filtered post sets for external use
- Update — modify post fields such as sentiment, priority, or tags
- Delete — remove specific posts from a project
- Get tags — retrieve the tags assigned to a post
- Translate — request a translation of the post text
- Summarize — generate an AI-based summary of a filtered dataset
Shared filters
Search, count, export, and summarize endpoints accept a common set of filters in the request body:
| Filter | Description |
|---|---|
startDate / endDate | Date range for post_time |
platform | One or more platform codes |
sentiment | Sentiment value filter |
priority | Priority value filter |
jobs | Filter by job id list |
tags | Filter by tag id list with operator (or, and, not) |
lang | Language code filter |
author | Author filter |
text_search | Boolean text search string |
Authentication
Authentication is required. See Authentication.
Permissions
Permissions are tier-based and vary by endpoint.
| Endpoint | Minimum tier |
|---|---|
post/search, post/count, post/export, post/gettags, post/translate, post/summarize | 4 (User) |
post/update, post/delete | 3 (Editor) |
Caching
Search and count responses may be served from cache. Send Cache-Control: no-cache to bypass the cache and force a live query.
Endpoints
- post/search — search posts with filters and pagination
- post/count — count posts matching filters
- post/export — export filtered posts
- post/update — update post fields
- post/delete — delete posts
- post/gettags — get tags for a post
- post/translate — translate post text
- post/summarize — AI-generated dataset summary
Notes
- All endpoints in this family require a
project_idto scope the operation. - This section documents only V2 paths (
/v2/...).