Create a comments relevance analysis request

Endpoint to submit a comments relevance request. COMMENTS_ANALYTICS.SUCCESS webhook event will be triggered once the submitted job is successful. Please refer the webhook events guide for more information.

POST /v1/insights/comments-analytics

Basic auth

curl 'https://api.staging.insightiq.ai/v1/insights/comments-analytics' \
  --request POST \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
  --header 'Content-Type: application/json' \
  --data '{
  "work_platform_id": "69dc0dd2-b78e-4013-b0d6-5693bb48b548",
  "content_url": "http://example.com",
  "brand_profile_url": "http://example.com"
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "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"
}

Accepted

Body

application/json

work_platform_id string · uuid required

Unique ID of the work platform

content_url string · uri required

Content URL for which the comments will be analysed for relevance

brand_profile_url string · uri required

Profile URL of the brand

Body

Responses