Yext Knowledge APIInstall

Summary

List social messages associated with a specified Yext account, optionally filtered and sorted by various criteria such as entity IDs, publishers, user name, message text, read/unread status, creation date range, and supports pagination.

Inputs

• Account Id (required) — The unique identifier for the Yext account from which to retrieve social messages.
• V (required) — The version date to use for the API request in YYYYMMDD format.
• Page Token — Token from a previous response's nextPageToken to retrieve the next page of results.
• Entity Ids — A JSON array filtering messages to those matching specified entity ID(s).
• Publishers — A JSON array filtering messages to those matching specified social publishers.
• User Name — Filter messages matching this user name (e.g., Facebook name or Instagram handle).
• Message Text — Filter messages containing the specified text.
• Sort By — Sort order of the results, defaults to NEWEST_TO_OLDEST.
• Read Unread Status — Filter messages by their read/unread status.
• Min Created Date — Minimum creation date/time in UTC (format YYYY-MM-DD HH:MM:SS) to filter messages.
• Max Created Date — Maximum creation date/time in UTC (format YYYY-MM-DD HH:MM:SS) to filter messages.
• Request Options — Additional request options such as batching, SSL validation, proxy, and timeout settings.

Output shape

a JSON object containing a list of social messages matching the filters and pagination parameters

Response may include a nextPageToken field to paginate further results. The operation uses the Yext Knowledge API's standard response structure with possible nested data fields.