Get content level social media screening report for a set of PII

Use this endpoint to retrieve social media background screening reports at the content level. This API is usually used in conjunction with the "SAFETY_FETCH.*" webhooks; read more in the documentation.

GET /v1/safety/profile-screening/{id}/contents

Basic auth

curl 'https://api.staging.insightiq.ai/v1/safety/profile-screening/id_01JXY9AZK4KV/contents?limit=10&offset=0&include_all=true&work_platform_ids=example&categories=example&keywords=example&published_from=example&published_to=example' \
  --request GET \
  --header 'Authorization: Basic YOUR_BASE64_CREDENTIALS'

{
  "data": [
    {
      "work_platform": {
        "id": "9bb8913b-ddd9-430b-a66a-d74d846e6c66",
        "name": "Instagram, Twitter",
        "logo_url": "https://insightiq.ai/storage/instagram.png"
      },
      "url": "https://example.com",
      "id": "id_01JXY9AZK4KV",
      "media_type": "example",
      "media_url": "https://example.com/media",
      "thumbnail_url": "https://example.com",
      "title": "example",
      "published_at": "2023-04-23T12:00:00",
      "category_risks": [
        {
          "category": "violence",
          "reason": "violence",
          "timestamps": [
            {}
          ]
        }
      ],
      "keywords": [
        {
          "term": "example",
          "action": "INCLUDE",
          "match_type": [
            {}
          ]
        }
      ]
    }
  ],
  "metadata": {
    "offset": 10,
    "limit": 12
  }
}

Path parameters

· 1

id string required

Unique id of the submitted request

Query parameters

· 8

limit integer · min: 1· max: 100· default: 10

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

offset integer · min: 0· default: 0

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

include_all boolean · enum

All analysed posts (including those that were flagged)

values

true
false

work_platform_ids string

If there are more than one, each work_platform_ids should be duplicated into its own entry, mapping directly to work_platform.id.

categories string

If there are more than one, each category should be duplicated into its own entry, mapping directly to category_risks.category.

keywords string

If there are more than one, each keyword should be duplicated into its own entry, matching keywords[].term.

published_from string

YYYY-MM-DD — inclusive; compare against published_at.

published_to string

YYYY-MM-DD — inclusive; compare against published_at

Path parameters

Query parameters

Responses