Insight

Insight allows you to collect insight data for keyword content understanding.

ENDPOINTS

[POST] /api/v2/products/insight
[PUT] /api/v2/products/insight/:id/pause
[PUT] /api/v2/products/insight/:id/resume

Create an insight

Creates and places new insight into queue

Request

ENDPOINT

[POST] /api/v2/products/insight

Payload

query hash Query of insight request. query.keywords string Keywords for insight analytic. query.platforms array of string Social media outlets to run analyses over. At least one of - twitter - reddit - news - youtube-videos - youtube-comments - facebook - instagram - linkedin - tiktok

query.dimensions array of string Dimensions involved in analysis. At least one of - textual - audial - visual

query.location optional string Specify cities or zip codes to gather data from. Only work on twitter, youtube-videos and youtube-comments

query.sneak_peek optional boolean If true, run preview analysis; else, run analysis continually over time

JSON EXAMPLE

{
    "query": {
        "keywords": "Lorem ipsum dolor sit amet",
        "platforms": [
            "twitter",
            "reddit",
            "news",
            "youtube-videos",
            "youtube-comments",
            "facebook",
            "instagram",
            "linkedin",
            "tiktok"
        ],
        "dimensions": [
            "textual",
            "visual",
            "audial"
        ]
    }
}

Example

curl -i -X POST 'https://product-api.redflagai.co/api/v2/products/insight \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{JWT_TOKEN}}' \
-d '{
    "query": {
        "keywords": "Lorem ipsum dolor sit amet",
        "platforms": [
            "twitter",
            "reddit",
            "news",
            "youtube-videos",
            "youtube-comments",
            "facebook",
            "instagram",
            "linkedin",
            "tiktok"
        ],
        "dimensions": [
            "textual",
            "visual",
            "audial"
        ]
    }
}'

Response

Successful or failed creation notice.

200 OK

{
    "notice": "Successfully created search. Now your search will be running continuously over time"
}

400 Bad

Pause an insight

Pauses the insight from collecting data.

ENDPOINT

[PUT] /api/v2/products/insight/:id/pause

Example

curl -i -X PUT 'https://product-api.redflagai.co/api/v2/products/insight/88/pause' \
-H 'Authorization: Bearer {{JWT_TOKEN}}'

Response

Successful or failed pause notice.

200 OK

{
    "notice": "Your Insight search has been paused"
}

400 Bad

Resume an insight

Resumes the insight to continue collecting data.

ENDPOINT

[PUT] /api/v2/products/insight/:id/resume

Example

curl -i -X PUT 'https://product-api.redflagai.co/api/v2/products/insight/1/resume' \
-H 'Authorization: Bearer {{JWT_TOKEN}}'

Response

Successful or failed resume notice.

200 OK

{
    "notice": "Your Insight search has been resumed"
}

400 Bad