Create a social listening request

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

Platforms supported: TikTok, Instagram, YouTube, Reddit, Substack, Facebook and X (formerly Twitter).

POST /v1/social/creators/contents/search

Basic auth

curl 'https://api.staging.insightiq.ai/v1/social/creators/contents/search' \
  --request POST \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS' \
  --header 'Content-Type: application/json' \
  --data '{
  "work_platform_id": "69dc0dd2-b78e-4013-b0d6-5693bb48b548",
  "keyword": "string",
  "hashtag": "string",
  "mention": "string",
  "items_limit": 0,
  "audio_track_info": {
    "title": "string",
    "id": "string"
  }
}'

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "work_platform": {
    "id": "9bb8913b-ddd9-430b-a66a-d74d846e6c66",
    "name": "Instagram",
    "logo_url": "https://insightiq.ai/storage/instagram.png"
  },
  "status": "IN_PROGRESS",
  "keyword": "string",
  "hashtag ": "string",
  "mention": "string",
  "items_limit": 0,
  "upload_date": "string",
  "sort_by": "string",
  "audio_track_info": {
    "title": "string",
    "id": "string"
  }
}

Accepted

Body

application/json

work_platform_id string · uuid required

Work platform id

keyword string

Keyword/phrase to search for content by. Developer can either pass a hashtag or a keyword or a mention.

hashtag string

Hashtag to search for content by (without the # prefix ). Developer can either pass a hashtag or a keyword or a mention. Reddit, Substack, Facebook does not support hashtag

mention string

Name of the profile/handle to search for content by (without the @ prefix). Developer can either pass a hashtag or a keyword or a mention. Reddit, Tiktok, Youtube, Substack, Facebook do not support mention'

items_limit integer

Maximum number of items to be fetched.

audio_track_info object

Audio track to fetch content by. Only for TikTok, cannot be used in conjunction with hashtag/keyword.

from_date string

Date-based filtering only for Facebook and X (formerly Twitter) content

to_date string

Date-based filtering only for Facebook and X (formerly Twitter) content

Body

Responses