Yext Knowledge APIInstall

Summary

Retrieve comments for a specific social media post of an entity in a Yext account, optionally paginating through results.

Inputs

• Account Id (required) — The ID of the Yext account from which to retrieve the post comments.
• V (required) — The API version date in YYYYMMDD format, specifying which version of the API to use.
• Entity Post Id (required) — The unique identifier of the social media post for which to fetch comments.
• Page Token — Token value to retrieve the next page of comments if the previous response was paginated.

Output shape

a JSON object containing the list of comments associated with the specified entity post, possibly including pagination tokens for further results

If there are more comments than can fit in a single response, the output includes a nextPageToken; pass this token via the Page Token input to fetch subsequent pages.

Examples

Example 1: Fetch first page of comments on a Facebook post for a known entity

Set Account Id, V (API version date), and Entity Post Id. Leave Page Token empty or unset to get the first page.

Example 2: Retrieve subsequent pages of comments when handling large volumes

Use the nextPageToken from the previous operation's output as the Page Token input to fetch additional comment pages.