GET
/
comments
/
:id
Available on Premium, Business, Enterprise plans.

Get comments for a post using the Ayrshare post ID, Social Post ID, Ayrshare Comment ID, or Social Comment ID with the Comment API.

Please see the Comments Overview for more information on the different ID types.

If using the Ayrshare Post ID no query parameters are required.

Additional Comment Details

  • Comment data is updated every 10 minutes for all platforms, with the exception of Twitter. Due to restrictions imposed by the Twitter API, the comment data for Twitter is refreshed using an exponential backoff strategy, meaning the intervals between updates gradually increase over time.

  • In the Facebook response, comment replies to replies always have the same parent.id.

  • Retrieve LinkedIn replies to comments by setting the "commentId": true and "searchPlatformId": true query parameters and providing the Social Comment ID in the path parameter.

Header Parameters

Authorization
string
required
API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY
Profile-Key
string
Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Path Parameters

Query Parameters

searchPlatformId
boolean
default: false

If getting comments on a post published via Ayrshare and using the Ayrshare Post ID, do not include this field - it defaults to false. If getting comments using the Social Post ID or Social Comment ID, which is the ID generated by the social networks, set to true.

commentId
boolean
default: false

If getting comments using the Social Comment ID, which is the comment ID generated by the social networks, set to true.

If getting comment using the Ayrshare Post ID or Social Post ID, do not include this field - it defaults to false.

If using the commentId query parameter, you must also set searchPlatformId to true.
platform
string

Required if searchPlatformId or commentId is true.

When to use:

  • If using the Social Post ID and "searchPlatformId": true field. Supported platforms: facebook, instagram, linkedin, tiktok, twitter, youtube,

  • If using the Social Comment ID and "searchPlatformId": true and "commentId": true fields. Supported platforms: facebook, instagram, linkedin.

  • If using the Ayrshare Post ID, do not include this field - comments will be returned from all platforms where the original post was published.

Comment GET Request Examples