Get the stream of analysed comments

Endpoint to retrieve list of comments for which the comments relevance insights is derived with the supplied job ID.

Usually used in conjunction with the "COMMENTS_ANALYTICS.*" webhooks, read more.

GET /v1/insights/comments-analytics/{id}/comments

Basic auth

curl 'https://api.staging.insightiq.ai/v1/insights/comments-analytics/123e4567-e89b-42d3-a456-426614174000/comments?type=RELEVANT_COMMENTS&limit=10&offset=0' \
  --request GET \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS'

{
  "comments_analytics": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "data": [
    {
      "work_platform": {
        "id": "fb83e3ca-eae7-4eaa-bf51-601ea4b3daeb",
        "name": "Instagram",
        "logo_url": "https://insightiq.ai/storage/instagram.png"
      },
      "content_url": "http://example.com",
      "brand_profile_url": "http://example.com",
      "text": "string",
      "sentiment": "POSITIVE",
      "relevance_score": 0,
      "type": "relevant_comments"
    }
  ],
  "metadata": {
    "limit": 0,
    "offset": 0
  }
}

Path parameters

· 1

id string · uuid required

Unique job ID

Query parameters

· 3

type string · enum required

Comment type

values

RELEVANT_COMMENTS
IRRELEVANT_COMMENTS

limit integer · default: 10 required

The number of comments to be returned. It can be between 1 to 100. The default value is 10.

offset integer · default: 0 required

The number of comments to skip. Use this argument for pagination. The default value is 0.

Path parameters

Query parameters

Responses