Skip to main content
POST

Authorizations

Authorization
string
header
required

API key passed as a Bearer token in the Authorization header.

Headers

x-api-version
enum<string>
default:2025-11-01
required

API version to use. This endpoint currently requires 2025-11-01.

Available options:
2025-11-01
Example:

"2025-11-01"

Body

application/json

Search filters, pagination, sorting, and field selection

Request body for the indexed social post search. Every key is optional; {} matches the whole dataset.

filters
object

A single SocialPostDbSearchCondition or a nested SocialPostDbSearchConditionGroup. Omit to match every indexed post.

cursor
string

Opaque cursor from a prior response's next_cursor. Send the same filters, sorts, and fields with it; a cursor issued for a different body is rejected with Invalid cursor.

limit
integer
default:20

Posts per page. 0 returns total_count alone and costs nothing.

Required range: 0 <= x <= 1000
sorts
object[]

Ordering rules applied in array order. Defaults to date_posted descending.

fields
string[]

Dot-paths to include in each returned post, for example actor.name or a whole group such as engagement. Omit to return everything. actor.location and reposter.location are selected whole; their sub-keys are filterable but not selectable. reactors and comments are returned in full and can be long, so leave them out unless you need them. Filter-only fields (content_type, materialized_at) are rejected here.

Example:

Response

Posts matching the search criteria with a pagination cursor and total count

posts
object[]
required

Matching posts for the current page. Empty when limit is 0 or nothing matches.

next_cursor
string | null
required

Opaque cursor for the next page. null on the last page and on limit: 0 queries.

total_count
integer
required

Total number of posts matching the filter across all pages.