Export

Exports allow you to retrieve a list of insight searches dataset.

ENDPOINTS

[POST] /api/v2/products/insight/exports
[GET] /api/v2/products/insight/exports/:id

The export object

Attributes

status string Current export status. One of pending, running, failed, or done.

query hash Query of export request. query.insight_search_ids array of integers List of insight searches IDs involved in this export. query.start_date string A cursor for use in pagination. Dataset that is created after this date is exported.

query.end_date string A cursor for use in pagination. Dataset that is created before this date is exported.

data array of hashes (only if status is done, otherwise null) Results of analyzed posting object from query.

JSON EXAMPLE

{
    "status": "done",
    "query": {
        "insight_search_ids": [1,2,3],
        "start_date": "2022-12-01",
        "end_date": "2022-12-31"
    },
    "data": [
        {
            "insight_search_id": "1",
            "social_id": "12345678910",
            "social_url": "https://www.example.com/p/12345678910",
            "platform": "twitter",
            "sentiments": "anger",
            "intentions": "assertion",
            "topic_1": "topic 1",
            "topic_2": "topic 2",
            "topic_3": "topic 3",
            "topic_4": "topic 4",
            "topic_5": "topic 5",
            "topic_6": "topic 6",
            "topic_7": "topic 7",
            "topic_8": "topic 8",
            "visual_detection_analyses": "label 1,label 2",
            "text_of_post": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
            "terms": "Lorem ipsum",
            "post_date": "12/1/2022",
    	    "post_time": "12:01:50",
            "text_post_lang": null,
            "text_post_type": null,
            "text_post_tagged_users": null,
            "text_post_tags": null,
            "geo_coordination": null,
            "place_type": null,
            "place_full_name": null,
            "place_country_code": null,
            "place_country_name": null,
            "place_id": null,
            "share_count": null,
            "like_count": null,
            "angry_count": null,
            "laugh_count": null,
            "love_count": null,
            "sad_count": null,
            "support_count": null,
            "wow_count": null,
            "appreciation_count": null,
            "empathy_count": null,
            "interest_count": null,
            "maybe_count": null,
            "praise_count": null,
            "digg_count": null,
            "reaction_total_count": null,
            "video_play_count": null,
            "video_view_count": null,
            "view_count": null,
            "comment_count": null,
            "share_with_comment_count": null,
            "author_id": null,
            "author_username": null,
            "author_type": null,
            "author_name": null,
            "more_info": null
        }
    ]
}

The posting object

Attributes

insight_search_id string Analyzed posting's insight search ID.

social_id optional string This posting social media ID.

social_url optional string This posting social media URL.

platform string This posting social media platform.

sentiments optional string Detected sentiment label on this posting. One of acceptance_self, acceptance, anger, annoyance, anxiety, calmness, contentment, disgust_self, disgust, dislike_self, dislike, eagerness, fear, joy, melancholy, pleasantness_self, pleasantness, responsiveness, sadness or serenity.

intentions optional string Detected intention label on this posting. Classified by affect: affective or denotative, time: present/past or future and description: descriptive or prescriptive. One of assertion, valuation, palinode, contrition, forecast, wish, proposal, inducement, or none.

Intention Label Classification - assertion (denotative, present/past, descriptive) - valuation (affective, present/past, descriptive) - palinode (denotative, present/past, prescriptive) - contrition (affective, present/past, prescriptive) - forecast (denotative, future, descriptive) - wish (affective, future, descriptive) - proposal (denotative, future, prescriptive) - inducement (affective, future, prescriptive)

topic_1 optional string First topic label. Word or phrase derived from this posting.

topic_2 optional string Second topic label. Word or phrase derived from this posting.

topic_3 optional string Third topic label. Word or phrase derived from this posting.

topic_4 optional string Fourth topic label. Word or phrase derived from this posting.

topic_5 optional string Fifth topic label. Word or phrase derived from this posting.

topic_6 optional string Sixth topic label. Word or phrase derived from this posting.

topic_7 optional string Seventh topic label. Word or phrase derived from this posting.

topic_8 optional string Eighth topic label. Word or phrase derived from this posting.

visual_detection_analyses optional array of strings Detected face, object, activity or logo label(s) on this posting.

text_of_post optional string This posting text.

terms string Subject of insight search to run analyses over. Separated by comma, if more.

post_date string This posting created date.

post_time string This posting created time.

text_post_lang optional string This posting text language.

text_post_type optional string This posting type.

text_post_tagged_users optional array of strings This posting tagged users.

text_post_tags optional array of strings This posting hashtags.

geo_coordination optional string Longitude and latitude this text posted.

place_type optional string Type of place this text posted.

place_full_name optional string Name of place this text posted.

place_country_code optional string Shortened country code this text posted.

place_country_name optional string Country this text posted.

place_id optional string Place ID this text posted.

share_count optional string This posting share count.

like_count optional string This posting like count.

angry_count optional string This posting angry count.

laugh_count optional string This posting laugh count.

love_count optional string This posting love count.

sad_count optional string This posting sad count.

support_count optional string This posting support count.

wow_count optional string This posting wow count.

appreciation_count optional string This posting appreciation count.

empathy_count optional string This posting empathy count.

interest_count optional string This posting interest count.

maybe_count optional string This posting maybe count.

share_count optional string This posting share count.

praise_count optional string This posting praise count.

digg_count optional string This posting digg count.

reaction_total_count optional string This posting total reaction count.

video_play_count optional string This posting video play count.

video_view_count optional string This posting video view count.

view_count optional string This posting view count.

share_with_comment_count optional string This posting share with comment count.

author_id optional string This posting author ID.

author_username optional string This posting author username.

author_type optional string This posting author type.

author_name optional string This posting author name.

more_info optional hash This posting additional info.

Create an export

Creates and places new export into queue. To check the status of an export, use show route.

Request

ENDPOINT

[POST] /api/v2/products/api/exports

Payload

insight_search_ids array of integers List of insight searches IDs involved in this export. start_date string A cursor for use in pagination. Dataset that is created after this date is exported.

end_date string A cursor for use in pagination. Dataset that is created before this date is exported.

JSON EXAMPLE

{
    "insight_search_ids": [1,2,3],
    "start_date": "2022-12-01",
    "end_date": "2022-12-31"
}

Example

curl -i -X POST 'https://product-api.redflagai.co/api/v2/products/insight/exports' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{JWT_TOKEN}}' \
-d '{
    "insight_search_ids": [1,2,3],
    "start_date": "2022-12-01",
    "end_date": "2022-12-31"
}'

Response

The export ID. To be used when retrieving export.

{
    "id": 1
}

Retrieve an export

Retrieves the export with given export ID.

ENDPOINT

[GET] /api/v2/products/insight/exports/:id

Example

curl -i -X GET 'https://product-api.redflagai.co/api/v2/products/insight/exports/1' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {{JWT_TOKEN}}'

Response

The export object.