Crimson Hexagon Developer Hub

Welcome to the Crimson Hexagon developer hub. You'll find comprehensive guides and API documentation to help you start working with Crimson Hexagon as quickly as possible!

Get Started
Suggest Edits

Authentication

Generate a token for use with all API requests.

All endpoints require an authentication token passed with the request.

Authentication tokens expire after 24 hours unless noExpiration is utilized.

 
gethttps://api.crimsonhexagon.com/api/authenticate
curl -X GET "https://api.crimsonhexagon.com/api/authenticate?username=example@crimsonhexagon.com&password=test1234&noExpiration=true"
var request = require("request");

var options = {
  method: 'GET',
  url: 'https://api.crimsonhexagon.com/api/authenticate',
  qs: {
    username: 'exmaple@acme.com',
    noExpiration: 'false',
    password: 'Password1234!' 
  }, headers: {} 
};

request(
  options,
  function (error, response, body) {
    if (error) throw new Error(error);
		console.log(body);
	}
);
import requests

url = "https://api.crimsonhexagon.com/api/authenticate"

querystring = {
  "username":"example@acme.com",
  "noExpiration":"false",
  "password":"Password1234!"
}

response = requests.request("GET", url, headers=headers, params=querystring)

print(response.text)
OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://api.crimsonhexagon.com/api/authenticate?username=example@acme.com&noExpiration=false&password=Password1234!")
  .get()
  .build();

Response response = client.newCall(request).execute();
A binary file was returned

You couldn't be authenticated

{
  "auth": "hT-UhX1M39fuTEKfHnAA5kHP9FUMWEgwnBJ9U9-PBJ4",
  "expires": "2016-07-29T19:45:56",
  "status": "success"
}
{
  "auth": "7emzqUEpDicmkdZy7Wqbli2izYOiRSZuPVOnwTpzM4g",
  "status": "success"
}
{
  "message": "Required String parameter 'password' is not present",
  "status": "error"
}
{
  "message": "Invalid credentials",
  "status": "error"
}

Query Params

username
string
required

username used to login to Crimson Hexagon dashboard

password
string
required

password utilized to login to Crimson Hexagon dashboard

noExpiration
boolean

If true, the authentication token returned will never expire.

force
boolean

If true a non-expiring authentication token will be reset

 

API Access

You must contact Crimson Hexagon support to enable API access for your username.

Every request requires an authentication query parameter

In your API requests ensure that you include auth as a query parameter with the value generated from this endpoint. For example:

https://api.crimsonhexagon.com/api/monitor/list?auth=abc123

Suggest Edits

Posts

Buzz, Opinion & Social Account Monitors

The posts endpoint returns post-level information (where available) and associated analysis (sentiment, emotion) for a given monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/posts
curl -X GET "https://api.crimsonhexagon.com/api/monitor/posts?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01&filter=site:blogspot.com,wordpress.com%7Ckeywords:android%7Cgeolocation:USA.NY.New%20York;GBR.Greater%20London.London&extendLimit=false&fullContents=true&geotagged=true"
A binary file was returned

You couldn't be authenticated

{
  "posts": [
    {
      "url": "http://www.facebook.com/113408673932/posts/10154437206813933?comment_id=10154437136223933",
      "date": "2016-07-14T18:56:24",
      "author": "Christina Jones",
      "contents": "So deserved!  <3 Love you, HBO!",
      "title": "HBO Wall - Reply to: Thank you, our fans, for helping us make #Emmys history once again.",
      "type": "Facebook",
      "language": "en",
      "assignedCategoryId": 3618925528,
      "assignedEmotionId": 3618925537,
      "categoryScores": [
        {
          "categoryId": 3618925528,
          "categoryName": "Basic Positive",
          "score": 1
        },
        {
          "categoryId": 3618925529,
          "categoryName": "Basic Neutral",
          "score": 0
        },
        {
          "categoryId": 3618925530,
          "categoryName": "Basic Negative",
          "score": 0
        }
      ],
      "emotionScores": [
        {
          "emotionId": 3618925540,
          "emotionName": "Fear",
          "score": 0
        },
        {
          "emotionId": 3618925536,
          "emotionName": "Anger",
          "score": 0.01
        },
        {
          "emotionId": 3618925537,
          "emotionName": "Joy",
          "score": 0.67
        },
        {
          "emotionId": 3618925538,
          "emotionName": "Sadness",
          "score": 0.07
        },
        {
          "emotionId": 3618925539,
          "emotionName": "Surprise",
          "score": 0.02
        },
        {
          "emotionId": 3618925534,
          "emotionName": "Neutral",
          "score": 0.19
        },
        {
          "emotionId": 3618925535,
          "emotionName": "Disgust",
          "score": 0.04
        }
      ]
    }
}
{
    "posts": [
        {
            "url": "http://twitter.com/mirl/status/882700164401692672",
            "title": "",
            "type": "Twitter",
            "location": "VA, USA",
            "geolocation": {
                "id": "USA.VA",
                "name": "Virginia",
                "country": "USA",
                "state": "VA"
            },
            "language": "en",
            "assignedCategoryId": 4763388608,
            "assignedEmotionId": 4763388602,
            "categoryScores": [
                {
                    "categoryId": 4763388606,
                    "categoryName": "Basic Negative",
                    "score": 0
                },
                {
                    "categoryId": 4763388610,
                    "categoryName": "Basic Positive",
                    "score": 0
                },
                {
                    "categoryId": 4763388608,
                    "categoryName": "Basic Neutral",
                    "score": 1
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 4763388602,
                    "emotionName": "Neutral",
                    "score": 0.86
                },
                {
                    "emotionId": 4763388603,
                    "emotionName": "Sadness",
                    "score": 0.01
                },
                {
                    "emotionId": 4763388607,
                    "emotionName": "Surprise",
                    "score": 0
                },
                {
                    "emotionId": 4763388604,
                    "emotionName": "Fear",
                    "score": 0
                },
                {
                    "emotionId": 4763388605,
                    "emotionName": "Disgust",
                    "score": 0
                },
                {
                    "emotionId": 4763388611,
                    "emotionName": "Anger",
                    "score": 0
                },
                {
                    "emotionId": 4763388609,
                    "emotionName": "Joy",
                    "score": 0.12
                }
            ],
            "imageInfo": [
                {
                    "url": "http://pbs.twimg.com/media/DD_7HvpWsAEHq4E.jpg"
                }
            ]
        }
    ],
  “totalPostsAvailable”: 1,
  “status”: “success”
}
{
    "posts": [
        {
            "url": "http://twitter.com/taddy_73/status/885919021249552384",
            "title": "",
            "type": "Twitter",
            "location": "Nottingham, East Midlands, GBR",
            "geolocation": {
                "id": "GBR.East Midlands.Nottingham",
                "name": "Nottingham",
                "country": "GBR",
                "state": "East Midlands",
                "city": "Nottingham"
            },
            "authorKlout": 41,
            "authorGender": "M",
            "assignedCategoryId": 0,
            "assignedEmotionId": 0,
            "imageInfo": [
                {
                    "url": "http://pbs.twimg.com/media/DEtqplgXcAIdb4V.jpg",
                    "brands": [
                        {
                            "brandId": "986",
                            "brand": "Absolut Vodka",
                            "size": "tiny",
                            "score": 1
                        }
                    ],
                    "objects": [
                        {
                            "score": 0.96909,
                            "classId": 59,
                            "className": "Brand"
                        },
                        {
                            "score": 0.87025,
                            "classId": 263,
                            "className": "Drink"
                        },
                        {
                            "score": 0.85578,
                            "classId": 527,
                            "className": "Distilled Beverage"
                        },
                        {
                            "score": 0.75006,
                            "classId": 161,
                            "className": "Product"
                        }
                    ]
                }
            ]
        }
      ],
    "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

filter
string

pipe-separated list of field:value pairs used to filter posts Read More...

extendLimit
boolean

if true, increases the limit of returned posts from 500 per call to 10,000 per call

fullContents
boolean

if true, the contents field will return the original, complete post contents instead of truncating around search terms

geotagged
boolean

if true, returns only geotagged documents matching and the given filter, if false or undefined any post matching the given filter

 

Please note: For Twitter, Tumblr and Google+ content, we are currently unable to show title and/or contents information via the API.
For Twitter, the following fields are not provided: author, date, title and contents, see limitations. If you wish, for Twitter, you may use the ID of the Tweet (included in the Tweet URL) and query the Twitter API for content information as described here.

This endpoint returns information that may be subject to sampling. For more information on how we sample, please refer to this help center article.

Suggest Edits

Sentiment & Categories

Buzz, Opinion & Social Account Monitors

The monitor results endpoint returns aggregate volume, sentiment, emotion and opinion category analysis for a given monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/results
curl -X GET "https://api.crimsonhexagon.com/api/monitor/results?auth=tokenHere&start=2010-01-01&end=2020-01-01&hideExcluded=false"
A binary file was returned

You couldn't be authenticated

{
  "results": [
    {
      "startDate": "2016-07-01T00:00:00",
      "endDate": "2016-07-02T00:00:00",
      "creationDate": "2016-07-18T18:26:09",
      "numberOfDocuments": 200677,
      "numberOfRelevantDocuments": 200677,
      "categories": [
        {
          "categoryId": 3735007912,
          "category": "Basic Negative",
          "proportion": 0.23,
          "volume": 45554,
          "hidden": false
        },
        {
          "categoryId": 3735007910,
          "category": "Basic Neutral",
          "proportion": 0.67,
          "volume": 134995,
          "hidden": false
        },
        {
          "categoryId": 3735007907,
          "category": "Basic Positive",
          "proportion": 0.1,
          "volume": 20128,
          "hidden": false
        }
      ],
      "emotions": [
        {
          "categoryId": 3735007903,
          "category": "Fear",
          "proportion": 0.1,
          "volume": 20589,
          "hidden": false
        },
        {
          "categoryId": 3735007911,
          "category": "Surprise",
          "proportion": 0,
          "volume": 843,
          "hidden": false
        },
        {
          "categoryId": 3735007909,
          "category": "Sadness",
          "proportion": 0.04,
          "volume": 7947,
          "hidden": false
        },
        {
          "categoryId": 3735007908,
          "category": "Anger",
          "proportion": 0.01,
          "volume": 2027,
          "hidden": false
        },
        {
          "categoryId": 3735007906,
          "category": "Disgust",
          "proportion": 0.13,
          "volume": 26971,
          "hidden": false
        },
        {
          "categoryId": 3735007905,
          "category": "Joy",
          "proportion": 0.08,
          "volume": 16456,
          "hidden": false
        },
        {
          "categoryId": 3735007904,
          "category": "Neutral",
          "proportion": 0.63,
          "volume": 125845,
          "hidden": false
        }
      ]
    }
  ],
  "status": "success"
}
{
  "message": "Full authentication is required to access this resource",
  "status": "error"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

hideExcluded
boolean

if true, categories set as hidden will not be included in category proportion calculations

 
Suggest Edits

Volume

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by date.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/dayandtime
curl -X GET "https://api.crimsonhexagon.com/api/monitor/dayandtime?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01&aggregatebyday=false&uselocaltime=false"
A binary file was returned

You couldn't be authenticated

{
  "volumes": [
    {
      "startDate": "2016-01-01T00:00:00",
      "endDate": "2016-01-02T00:00:00",
      "numberOfDocuments": 184249,
      "volume": {
        "0": 2004,
        "1": 1056,
        "2": 1074,
        "3": 1127,
        "4": 1074,
        "5": 698,
        "6": 698,
        "7": 931,
        "8": 1056,
        "9": 984,
        "10": 1378,
        "11": 1646,
        "12": 1718,
        "13": 2219,
        "14": 2756,
        "15": 1897,
        "16": 4581,
        "17": 2613,
        "18": 3006,
        "19": 2720,
        "20": 2165,
        "21": 5243,
        "22": 4080,
        "23": 2917
      }
    }
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

aggregatebyday
boolean

if true, volume information will be aggregated by day of the week instead of time of day

uselocaltime
boolean

if true, volume aggregation will use the time local to the publishing author of a post when determining counts by day/time, instead of converting that time to the timezone of the selected monitor

 
Suggest Edits

Image Analysis

Buzz, Opinion & Social Account Monitors

The monitor image analysis endpoint returns a breakdown of the top image classes within a provided monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/imageresults
curl -X GET "https://api.crimsonhexagon.com/api/monitor/imageresults?auth=tokenHere&start=2010-01-01&end=2020-01-01&hideExcluded=false"
A binary file was returned

You couldn't be authenticated

{
    "results": [
        {
            "startDate": "2017-07-10T00:00:00",
            "endDate": "2017-07-11T00:00:00",
            "creationDate": "2017-07-24T13:22:02",
            "numberOfDocuments": 482,
            "numberOfImageDocuments": 482,
            "imageClasses": [],
            "logoClasses": [
                {
                    "id": 986,
                    "name": "Absolut Vodka",
                    "type": "logo",
                    "volume": 482,
                    "proportion": 1
                },
                {
                    "id": 840,
                    "name": "Malibu",
                    "type": "logo",
                    "volume": 5,
                    "proportion": 0.010373444
                },
                {
                    "id": 557,
                    "name": "Moet",
                    "type": "logo",
                    "volume": 5,
                    "proportion": 0.010373444
                },
                {
                    "id": 10026,
                    "name": "Absolut Elyx",
                    "type": "logo",
                    "volume": 3,
                    "proportion": 0.0062240665
                },
                {
                    "id": 10025,
                    "name": "Ballantines",
                    "type": "logo",
                    "volume": 2,
                    "proportion": 0.004149378
                },
                {
                    "id": 4192,
                    "name": "Google Gonly",
                    "type": "logo",
                    "volume": 2,
                    "proportion": 0.004149378
                }
            ]
        }
   	],
  "status": "success"
}
{
    "results": [
        {
            "startDate": "2017-07-10T00:00:00",
            "endDate": "2017-07-11T00:00:00",
            "creationDate": "2017-07-24T13:22:02",
            "numberOfDocuments": 482,
            "numberOfImageDocuments": 482,
            "imageClasses": [
                {
                    "id": 57,
                    "name": "Night",
                    "type": "scene",
                    "volume": 10,
                    "proportion": 0.020746889
                },
                {
                    "id": 104,
                    "name": "Crowd",
                    "type": "scene",
                    "volume": 4,
                    "proportion": 0.008298756
                },
                {
                    "id": 206,
                    "name": "Event",
                    "type": "scene",
                    "volume": 3,
                    "proportion": 0.0062240665
                },
                {
                    "id": 429,
                    "name": "Dance",
                    "type": "scene",
                    "volume": 2,
                    "proportion": 0.004149378
                },
                {
                    "id": 1418,
                    "name": "Concert Dance",
                    "type": "scene",
                    "volume": 2,
                    "proportion": 0.004149378
                },
                {
                    "id": 1039,
                    "name": "Modern Dance",
                    "type": "scene",
                    "volume": 2,
                    "proportion": 0.004149378
                },
                {
                    "id": 95,
                    "name": "Stage",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 1192,
                    "name": "Graduation",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 381,
                    "name": "Rock Concert",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 212,
                    "name": "Atmosphere",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 71,
                    "name": "Atmosphere Of Earth",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 183,
                    "name": "Concert",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 109,
                    "name": "Performance",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                },
                {
                    "id": 1725,
                    "name": "Universe",
                    "type": "scene",
                    "volume": 1,
                    "proportion": 0.002074689
                }
            ],
            "logoClasses": []
        }
    ],
    "status":"success"
}
{
    "results": [
        {
            "startDate": "2017-07-10T00:00:00",
            "endDate": "2017-07-11T00:00:00",
            "creationDate": "2017-07-24T13:22:02",
            "numberOfDocuments": 482,
            "numberOfImageDocuments": 482,
            "imageClasses": [
                {
                    "id": 4,
                    "name": "Person",
                    "type": "object",
                    "volume": 171,
                    "proportion": 0.3547718
                },
                {
                    "id": 316,
                    "name": "Speech",
                    "type": "object",
                    "volume": 152,
                    "proportion": 0.3153527
                },
                {
                    "id": 363,
                    "name": "Player",
                    "type": "object",
                    "volume": 80,
                    "proportion": 0.16597511
                },
                {
                    "id": 506,
                    "name": "Football Player",
                    "type": "object",
                    "volume": 80,
                    "proportion": 0.16597511
                }
              ]
        }
      ],
  "status":"success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

type
string

specifies type of image classes, valid values [object, scene, action, logo]

top
int32

if defined, only the selected number of classes will be returned

 
Suggest Edits

Top Sources

Buzz, Opinion & Social Account Monitors

The top sources endpoint returns volume information related to the sites and content sources (e.g. Twitter, Forums, Blogs, etc.) in a monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/sources
curl -X GET "https://api.crimsonhexagon.com/api/monitor/sources?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "contentSources": [
    {
      "startDate": "2016-07-01T00:00:00",
      "endDate": "2016-07-02T00:00:00",
      "topSites": {
        "twitter.com": 138707,
        "tumblr.com": 35127,
        "facebook.com": 10271,
        "4chan.org": 3290,
        "reddit.com": 1492,
        "democraticunderground.com": 1167,
        "fark.com": 1071,
        "bodybuilding.com": 440
      },
      "sources": {
        "Blogs": 2330,
        "Comments": 450,
        "Tumblr": 35127,
        "Forums": 13792,
        "Twitter": 138707,
        "Facebook": 10271,
        "Google Plus": 0
      }
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Interest Affinities

Buzz, Opinion & Social Account Monitors

The Monitor Interest Affinity endpoint returns information about the authors in a monitor and their affinity with a range of pre-defined topics.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/interestaffinities
curl -X GET "https://api.crimsonhexagon.com/api/monitor/interestaffinities?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01&daily=false&documentsource=TWITTER"
A binary file was returned

You couldn't be authenticated

{
  "startDate": "2016-01-01T00:00:00",
  "endDate": "2016-07-01T00:00:00",
  "affinityInfo": [
    {
      "id": 668,
      "name": "Affordable Care Act",
      "relevancyScore": 22.5,
      "percentInMonitor": 7.15,
      "percentOnTwitter": 0.306
    },
    {
      "id": 3384,
      "name": "Msnbc",
      "relevancyScore": 22.4,
      "percentInMonitor": 5.366,
      "percentOnTwitter": 0.083
    },
    {
      "id": 3730,
      "name": "Politico",
      "relevancyScore": 15,
      "percentInMonitor": 5.042,
      "percentOnTwitter": 0.255
    }
}
{
  "message": "Interest affinities are only available for monitors with Twitter content.",
  "status": "error"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

specifies inclusive start date in YYYY-MM-DD

end
date
required

specifies exclusive end date in YYYY-MM-DD

daily
boolean

if true, results returned from this endpoint will be trended daily instead of aggregated across the selected date range.

documentsource
string

document source for affinities. valid params include TWITTER or TUMBLR

 

Volume Requirements

There must be at least 250 tweets in the selected date range to use Affinities.

Each interest must have a minimum of 5 posts and average at least 5 authors per day. If one or more of these requirements is not met for the selected monitor and date range, users will receive an error when requesting results from this endpoint. This endpoint takes an optional daily request parameter that splits results returned up by day.

Suggest Edits

Word Cloud

Buzz, Opinion & Social Account Monitors

The Word Cloud endpoint returns an alphabetized list of the top 300 words in a monitor. This data is generated using documents randomly selected from the pool defined by the submitted parameters.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/wordcloud
curl -X GET "https://api.crimsonhexagon.com/api/monitor/wordcloud?auth=tokenHere&id=3735007902&start=2016-01-01&end=2016-07-01&filter=filter=site:blogspot.com,wordpress.com%7Ckeywords:android%7Cgeolocation:USA.NY.New%20York;GBR.Greater%20London.London"
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "2000": 29,
    "2016": 39,
    "#demsinphilly": 13,
    "#np": 13,
    "#soundcloud": 26,
    "#trump2016": 65,
    "#trumptrain": 38,
    "@hillaryclinton": 22,
    "@realdonaldtrump": 17,
    "@stylishrentals": 39,
    "able": 13,
    "across": 23,
    "actual": 16,
    "against": 44,
    "america": 79,
    "american": 29,
    "americans": 33,
    "among": 14
  },
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

filter
string

pipe-separated list of field:value pairs used to filter results by given parameters, more information is available in the FAQ

 
Suggest Edits

Demographics & Location

 

This collection of endpoints provide demographic volume metrics for users within a given monitor.

Suggest Edits

Age

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by age bracket.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/demographics/age
curl -X GET "https://api.crimsonhexagon.com/api/monitor/demographics/age?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "ageCounts": [
    {
      "startDate": "2016-07-01T00:00:00",
      "endDate": "2016-07-02T00:00:00",
      "numberOfDocuments": 200677,
      "ageCount": {
        "sortedAgeCounts": {
          "ZERO_TO_SEVENTEEN": 1762,
          "EIGHTEEN_TO_TWENTYFOUR": 1128,
          "TWENTYFIVE_TO_THIRTYFOUR": 1208,
          "THIRTYFIVE_AND_OVER": 16892
        },
        "totalAgeCount": 20990
      }
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 

Possible Age Brackets

ZERO_TO_SEVENTEEN
EIGHTEEN_TO_TWENTYFOUR
TWENTYFIVE_TO_THIRTYFOUR
THIRTYFIVE_AND_OVER

Suggest Edits

Ethnicity

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by ethnicity.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/demographics/ethnicity
curl -X GET "https://api.crimsonhexagon.com/api/monitor/demographics/ethnicity?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "ethnicityCounts": [
    {
      "startDate": "2016-01-01T00:00:00",
      "endDate": "2016-01-02T00:00:00",
      "numberOfDocuments": 184249,
      "ethnicityCount": {
        "sortedEthnicityCounts": {
          "asian": 321,
          "black": 334,
          "latino": 208,
          "white": 1493
        },
        "totalEthnicityCount": 2356
      }
    }
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 

US Only Endpoint

The information in this endpoint is only available to US-based customers. Users from outside the United States attempting to access this endpoint will receive an error response.

How is Ethnicity Determined?

Ethnicity is determined by utilizing US census data and definitions.

Suggest Edits

Gender

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by gender.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/demographics/gender
curl -X GET "https://api.crimsonhexagon.com/api/monitor/demographics/gender?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "genderCounts": [
    {
      "startDate": "2016-01-01T00:00:00",
      "endDate": "2016-01-02T00:00:00",
      "numberOfDocuments": 184249,
      "genderCounts": {
        "maleCount": 27104,
        "femaleCount": 25185,
        "totalGenderedCount": 52289,
        "percentMale": 51,
        "percentFemale": 49
      }
    }
  ]
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

City

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by city.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/geography/cities
curl -X GET "https://api.crimsonhexagon.com/api/monitor/geography/cities?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01&country=usa"
A binary file was returned

You couldn't be authenticated

{
  "startDate": "2016-01-01T00:00:00",
  "endDate": "2016-07-01T00:00:00",
  "totalVolume": 48994699,
  "data": [
    {
      "info": {
        "id": "USA.AK.Anchorage",
        "name": "Anchorage",
        "country": "USA",
        "state": "AK",
        "city": "Anchorage",
        "latitude": 61.21997,
        "longitude": -149.9002
      },
      "volume": 6525,
      "perMillion": 25624
    },
    {
      "info": {
        "id": "USA.AL.Auburn",
        "name": "Auburn",
        "country": "USA",
        "state": "AL",
        "city": "Auburn",
        "latitude": 32.6097,
        "longitude": -85.48084
      },
      "volume": 1440,
      "perMillion": 13621
    }
  ]
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

country
string

the ISO 3166 three letter country code, if not given all cities in the world will be returned

 
Suggest Edits

State

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by state.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/geography/states
curl -X GET "https://api.crimsonhexagon.com/api/monitor/geography/states?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01&country=usa"
A binary file was returned

You couldn't be authenticated

{
  "startDate": "2016-01-01T00:00:00",
  "endDate": "2016-07-01T00:00:00",
  "totalVolume": 48994699,
  "data": [
    {
      "info": {
        "id": "USA.AK",
        "name": "Alaska",
        "country": "USA",
        "state": "AK",
        "latitude": 64.260765,
        "longitude": -152.27791
      },
      "volume": 34554,
      "perMillion": 48651
    },
    {
      "info": {
        "id": "USA.AL",
        "name": "Alabama",
        "country": "USA",
        "state": "AL",
        "latitude": 32.78917,
        "longitude": -86.82873
      },
      "volume": 146737,
      "perMillion": 30699
    }
  ]
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

country
string
required

the ISO 3166 three letter country code

 
Suggest Edits

Country

Buzz, Opinion & Social Account Monitors

Returns volume metrics for a given monitor split by country.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/geography/countries
curl -X GET "https://api.crimsonhexagon.com/api/monitor/geography/countries?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "startDate": "2016-01-01T00:00:00",
  "endDate": "2016-07-01T00:00:00",
  "totalVolume": 48994699,
  "data": [
    {
      "info": {
        "id": "ABW",
        "name": "Aruba",
        "country": "ABW",
        "latitude": 12.516935,
        "longitude": -69.9742
      },
      "volume": 214,
      "perMillion": 2076
    },
    {
      "info": {
        "id": "AFG",
        "name": "Afghanistan",
        "country": "AFG",
        "latitude": 33.836266,
        "longitude": 66.008446
      },
      "volume": 1525,
      "perMillion": 53
    }
  ]
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
 

This collection of endpoints relate provide metrics specific to Twitter from either Social Account or Buzz monitors.

Suggest Edits

Twitter Authors

Buzz, Opinion & Social Account Monitors w/ Twitter Content

The authors endpoint returns information related to the Twitter authors who have posted in a given monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/authors
curl -X GET "https://api.crimsonhexagon.com/api/monitor/authors?auth=tokenhere&id=3735007902&start=2016-01-01&end=2016-07-01"
A binary file was returned

You couldn't be authenticated

{
  "authors": [
    {
      "startDate": "2016-02-01T00:00:00",
      "endDate": "2016-02-02T00:00:00",
      "authorDetails": [
        {
          "kloutScore": 97,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 95,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 95,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 95,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 94,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 94,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 94,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 94,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 93,
          "detailsDate": "2016-02-01T00:00:00"
        },
        {
          "kloutScore": 93,
          "detailsDate": "2016-02-01T00:00:00"
        }
      ],
      "numberOfAuthors": 5569,
      "docsPerAuthor": 1.7956545,
      "totalImpressions": 18908258565
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Twitter Engagement Metrics

Buzz, Opinion & Social Account Monitors w/ Twitter Content

The Twitter Engagement Metrics endpoint returns information about the top hashtags and top retweets in a monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/twittermetrics
curl -X GET "https://api.crimsonhexagon.com/api/monitor/twittermetrics?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
    "dailyResults": [
        {
            "startDate": "2017-10-12T00:00:00",
            "endDate": "2017-10-13T00:00:00",
            "topHashtags": {
                "#wonderwoman": 56,
                "#ThorRagnarokEvent": 34,
                "#GOTGVol2": 33,
                "#GuardiansOfTheGalaxy": 32,
                "#marvel": 30,
                "#Cars3Bluray": 27,
                "#AMAs": 23,
                "#Groot": 22,
                "#Starlord": 18,
                "#fashion": 16
            },
            "topRetweets": [
                {
                    "url": "http://twitter.com/WGladstone/status/918486999442579457",
                    "isOriginal": true,
                    "retweetCount": 56
                },
                {
                    "url": "http://twitter.com/LovePeaceMommy/status/917557492917219330",
                    "isOriginal": true,
                    "retweetCount": 27
                },
                {
                    "url": "http://twitter.com/BobbyBigWheel/status/918474044084817921",
                    "isOriginal": true,
                    "retweetCount": 26
                },
                {
                    "url": "http://twitter.com/mazzie/status/918263777036046337",
                    "isOriginal": true,
                    "retweetCount": 25
                },
                {
                    "url": "http://twitter.com/commondsneyfan/status/918613198412091392",
                    "isOriginal": true,
                    "retweetCount": 21
                },
                {
                    "url": "http://twitter.com/bleuvaIentine/status/918672842279047168",
                    "isOriginal": true,
                    "retweetCount": 17
                },
                {
                    "url": "http://twitter.com/JamesGunn/status/918592853667926017",
                    "isOriginal": true,
                    "retweetCount": 16
                },
                {
                    "url": "http://twitter.com/AMAs/status/918478536742125568",
                    "isOriginal": true,
                    "retweetCount": 13
                },
                {
                    "url": "http://twitter.com/Xbox/status/918234774040297472",
                    "isOriginal": true,
                    "retweetCount": 9
                },
                {
                    "url": "http://twitter.com/annieenasta/status/917567272809623552",
                    "isOriginal": true,
                    "retweetCount": 8
                }
            ]
        }
    ],
    "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Twitter Followers

Twitter Social Account Monitors

Twitter Followers returns the cumulative daily follower count for a targeted Twitter account in a Twitter Social Account Monitor as of the selected dates.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/twittersocial/followers
curl -X GET "https://api.crimsonhexagon.com/api/monitor/twittersocial/followers?auth=tokenhere&id=%7B%7Btwitter%7D%7D&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "date": "2016-07-01T00:00:00",
      "followers": 492439
    }
  ],
  "status": "success"
}
{
  "message": "Monitor 123456789 is not a Twitter Social Monitor",
  "status": "error"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Twitter Sent Posts

Twitter Social Account Monitors

Twitter Sent Posts returns information about posts sent by the owner of a target Twitter account in a Twitter Social Account Monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/twittersocial/sentposts
curl -X GET "https://api.crimsonhexagon.com/api/monitor/twittersocial/sentposts?auth=tokenhere&id=%7B%7Btwitter%7D%7D&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-07-01T00:00:00",
      "endDate": "2016-07-02T00:00:00",
      "sentPostMetrics": [
        {
          "url": "http://twitter.com/BostonGlobe/status/749013219319185408",
          "date": "2016-07-01T22:54:02",
          "retweets": 2,
          "replies": 0,
          "impressions": 494376,
          "content": "Why your Clover food scraps might be headed for the dump https://t.co/KIr1qmaZR5"
        }
      ],
      "totalImpressions": 110674325
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Twitter Total Engagement

Twitter Social Account Monitors

Twitter Total Engagement returns information about retweets, replies, and @mentions for a Twitter Social Account monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/twittersocial/totalengagement
curl -X GET "https://api.crimsonhexagon.com/api/monitor/twittersocial/totalengagement?auth=tokenhere&id=%7B%7Btwitter%7D%7D&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-07-01T00:00:00",
      "endDate": "2016-07-02T00:00:00",
      "mentions": 1378,
      "replies": 171,
      "retweets": 1775
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
 

This collection of endpoints relate provide metrics specific to Facebook from either Social Account or Buzz monitors.

Suggest Edits

Facebook Admin Posts

Facebook Social Account Monitors

Returns those posts made by the administrators/owners of a targeted Facebook page in a Facebook Social Account Monitor.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/facebook/adminposts
curl -X GET "https://api.crimsonhexagon.com/api/monitor/facebook/adminposts?auth=tokenhere&id=123456789&start=2010-01-01&end=2016-08-15"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-08-17T00:00:00",
      "endDate": "2016-08-18T00:00:00",
      "adminPostMetrics": [
        {
          "url": "http://www.facebook.com/223649167822693/posts/556265841227689",
          "date": "2016-08-17T10:02:00",
          "content": "Vox\n\nIf you had to isolate one factor as the key linchpin upon which any credible global solution must turn, it is this: coal in China.",
          "postLikes": 36,
          "postShares": 7,
          "postComments": 3,
          "isLocked": false
        }
      ]
    },
    {
      "startDate": "2016-08-18T00:00:00",
      "endDate": "2016-08-19T00:00:00",
      "adminPostMetrics": [
        {
          "url": "http://www.facebook.com/223649167822693/posts/557518357769104",
          "date": "2016-08-18T15:01:01",
          "content": "Vox\n\nRyan Lochte has triggered the most confusing story to come out of the Rio 2016 Olympics.",
          "postLikes": 160,
          "postShares": 81,
          "postComments": 86,
          "isLocked": false
        }
      ]
    },
    {
      "startDate": "2016-08-19T00:00:00",
      "endDate": "2016-08-20T00:00:00",
      "adminPostMetrics": [
        {
          "url": "http://www.facebook.com/223649167822693/posts/558088927712047",
          "date": "2016-08-19T21:50:00",
          "content": "Vox\n\nThe Amber Heard story shows everything that’s wrong with how our culture treats abuse victims.",
          "postLikes": 1233,
          "postShares": 333,
          "postComments": 168,
          "isLocked": false
        }
      ]
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date

end
date
required

exclusive end date

 
Suggest Edits

Facebook Page Likes

Facebook Social Account Monitors

Returns the cumulative daily like count for a targeted Facebook page in a Facebook Social Account Monitor as of the selected dates.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/facebook/pagelikes
curl -X GET "https://api.crimsonhexagon.com/api/monitor/facebook/pagelikes?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "date": "2016-08-17T00:00:00",
      "likes": 900084
    },
    {
      "date": "2016-08-18T00:00:00",
      "likes": 901775
    },
    {
      "date": "2016-08-19T00:00:00",
      "likes": 904742
    },
    {
      "date": "2016-08-20T00:00:00",
      "likes": 907312
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Facebook Total Activity

Facebook Social Account Monitors

Returns information about actions (likes, comments, shares) made by users and admins for a given page.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/facebook/totalactivity
curl -X GET "https://api.crimsonhexagon.com/api/monitor/facebook/totalactivity?auth=tokenhere&start=2010-01-01&end=2020-01-01&id=123456789"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-08-17T00:00:00",
      "endDate": "2016-08-18T00:00:00",
      "admin": {
        "adminPosts": 621,
        "likesOnAdmin": 431678,
        "commentsOnAdmin": 66601,
        "sharesOnAdmin": 188723
      },
      "user": {
        "userPosts": 0,
        "likesOnUser": 0,
        "commentsOnUser": 0,
        "sharesOnUser": 0
      }
    },
    {
      "startDate": "2016-08-18T00:00:00",
      "endDate": "2016-08-19T00:00:00",
      "admin": {
        "adminPosts": 33,
        "likesOnAdmin": 21686,
        "commentsOnAdmin": 3646,
        "sharesOnAdmin": 12299
      },
      "user": {
        "userPosts": -17,
        "likesOnUser": 3593,
        "commentsOnUser": 435,
        "sharesOnUser": 1619
      }
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
date
required

inclusive start date in YYYY-MM-DD

end
date
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Instagram

 

This collection of endpoints relate provide metrics specific to Instagram from either Social Account or Buzz monitors.

Suggest Edits

Instagram Top Hashtags

Buzz or Opinion Monitor w/ Instagram Content

Returns the Top 50 most occurring Hashtags contained within the posts analyzed in a monitor, plus all explicitly targeted hashtags in a monitor's query, for which Metrics are being collected (i.e. for which the hashtags are being tracked explicitly in ForSight)

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/instagram/hashtags
curl -X GET "https://api.crimsonhexagon.com/api/monitor/instagram/hashtags?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{'dailyResluts': 
 [{'date': '2017-07-27T00:00:00',
   'hashtags': 
    { '#amazing': 188516398,
        '#art': 271235073,
        '#beach': 153031407,
        '#beautiful': 403149690,
        '#beauty': 181708324,
        '#cool': 112275282,
                   	
        '#summer': 297034848,
        '#sun': 162897939,
        '#travel': 199149490}
    },
    {'date': '2017-07-28T00:00:00',
   	'hashtags': 
    { '#amazing': 188516398,
        '#art': 271235073,
        '#beach': 153031407,
        '#beautiful': 403149690,
        '#beauty': 181708324,
        '#cool': 112275282,
                   	
        '#summer': 297034848,
        '#sun': 162897939,
        '#travel': 199149490}
    },
    {'date': '2017-07-29T00:00:00',
   	'hashtags': 
    { '#amazing': 188516398,
        '#art': 271235073,
        '#beach': 153031407,
        '#beautiful': 403149690,
        '#beauty': 181708324,
        '#cool': 112275282,
                   	
        '#summer': 297034848,
        '#sun': 162897939,
        '#travel': 199149490}
    }
  ],
 'status': 'success'}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
string
required

inclusive start date in YYYY-MM-DD

end
string
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Instagram Followers

Instagram Social Account Monitor

Returns the cumulative daily follower count for a targeted Instagram account in an Instagram Social Account Monitor as of the selected dates.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/instagram/followers
curl -X GET "https://api.crimsonhexagon.com/api/monitor/instagram/followers?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "date": "2016-08-17T00:00:00",
      "followerCount": 228266
    },
    {
      "date": "2016-08-18T00:00:00",
      "followerCount": 228490
    },
    {
      "date": "2016-08-19T00:00:00",
      "followerCount": 228746
    },
    {
      "date": "2016-08-20T00:00:00",
      "followerCount": 229206
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
string
required

inclusive start date in YYYY-MM-DD

end
string
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Instagram Sent Media

Instagram Social Account Monitor

Returns media sent by admins in a targeted Instagram account.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/instagram/sentmedia
curl -X GET "https://api.crimsonhexagon.com/api/monitor/instagram/sentmedia?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-08-17T00:00:00",
      "endDate": "2016-08-18T00:00:00",
      "adminPostMetrics": [
        {
          "url": "https://www.instagram.com/p/BJOjhJJg8j0/",
          "date": "2016-08-17T22:58:31",
          "content": "Sometimes my mind wanders while I'm writing.. -LS",
          "postLikes": 6423,
          "postComments": 52,
          "postTags": "",
          "isLocked": false
        }
      ]
    },
    {
      "startDate": "2016-08-18T00:00:00",
      "endDate": "2016-08-19T00:00:00",
      "adminPostMetrics": [
        {
          "url": "https://www.instagram.com/p/BJQsgOJA40z/",
          "date": "2016-08-18T18:55:31",
          "content": "Wrapped up testing of the Dr Zaber Sentry. Here's full load with a \"torture\" configuration :D",
          "postLikes": 7394,
          "postComments": 44,
          "postTags": "",
          "isLocked": false
        }
      ]
    },
    {
      "startDate": "2016-08-19T00:00:00",
      "endDate": "2016-08-20T00:00:00",
      "adminPostMetrics": []
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
string
required

inclusive start date in YYYY-MM-DD

end
string
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Instagram Total Activity

Instagram Social Account Monitor

Returns information about actions (likes, comments) made by users and admins for a given account.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/instagram/totalactivity
curl -X GET "https://api.crimsonhexagon.com/api/monitor/instagram/totalactivity?auth=tokenhere&id=123456789&start=2010-01-01&end=2020-01-01"
A binary file was returned

You couldn't be authenticated

{
  "dailyResults": [
    {
      "startDate": "2016-08-17T00:00:00",
      "endDate": "2016-08-18T00:00:00",
      "admin": {
        "adminPosts": 1,
        "likesOnAdmin": 1461,
        "commentsOnAdmin": 20
      }
    },
    {
      "startDate": "2016-08-18T00:00:00",
      "endDate": "2016-08-19T00:00:00",
      "admin": {
        "adminPosts": 1,
        "likesOnAdmin": 9211,
        "commentsOnAdmin": 63
      }
    },
    {
      "startDate": "2016-08-19T00:00:00",
      "endDate": "2016-08-20T00:00:00",
      "admin": {
        "adminPosts": 0,
        "likesOnAdmin": 2616,
        "commentsOnAdmin": 9
      }
    },
    {
      "startDate": "2016-08-20T00:00:00",
      "endDate": "2016-08-21T00:00:00",
      "admin": {
        "adminPosts": 1,
        "likesOnAdmin": 7216,
        "commentsOnAdmin": 58
      }
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

start
string
required

inclusive start date in YYYY-MM-DD

end
string
required

exclusive end date in YYYY-MM-DD

 
Suggest Edits

Train Monitor

The Monitor Training Document Upload endpoint allows users to train individual monitors programmatically. You may only upload one document per request.

Due to the restrictions involved in using this endpoint, unless you have a specific need to train monitors programmatically, training monitors via the user interface in ForSight will normally be the more efficient training option.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.crimsonhexagon.com/api/monitor/train
{
  "monitorid": 123456789,
  "categoryid": 6779843,
  "document": {
    "title": "My day at the fair",
    "date": "2010-04-19T23:14:00",
    "author": "me",
    "url": "http://www.blog.com/2010/04/19/my-day-at-the-fair",
    "contents": "Today I went to the fair and...",
    "language": "en"
  }
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

id
string
required

the id of the monitor being trained

monitorid
string
required

the id of the monitor being trained

categoryid
string
required

the category this content should belong to

document
object
 
document.title
string
required

title of the document being uploaded

document.date
date
required

the date when this document was authored

document.author
string
required

the name of the author

document.url
string
required

url source of this document

document.content
string
required

the text of the document

document.language
string
required

two letter language code

 
Suggest Edits

Trained Posts

Monitor Training Posts returns a list of the training posts for a given opinion monitor. The selected monitor must be an opinion monitor; requests for other monitor types will return an error. By default, all training posts for all categories in a monitor will be returned, however you may pass a category ID in your request to get training posts from a specific category.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/trainingposts
curl -X GET "https://api.crimsonhexagon.com/api/monitor/trainingposts?auth=tokenhere&id=123456789&category"
A binary file was returned

You couldn't be authenticated

{
  "trainingPosts": [
    {
      "url": "http://twitter.com/selevengers/status/775355704207085568",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/isadoracristt/status/779005546636664832",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/MisteCaulder/status/776225638051176448",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/producermm69/status/782796247916646401",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/georgethomasccs/status/780711837876838400",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/MunchTrip/status/781763874550845440",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/draftbreakdown/status/776400187338035200",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/Egohusky/status/778253011307159557",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/FreeThoughtSite/status/779702508365029376",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    },
    {
      "url": "http://twitter.com/AmarCrow/status/777528911303356416",
      "title": "",
      "type": "Twitter",
      "categoryId": 4309222425,
      "categoryName": "Positive"
    }
  ],
  "status": "success"
}
{
  "message": "Selected monitor is not an opinion monitor",
  "status": "error"
}

Query Params

id
int64
required

id of the monitor or monitor filter being requested

category
int64

category id to target training posts from a specific category

 

This endpoint is subject to the same content restrictions as other endpoints that return posts.

Suggest Edits

Monitor Audit

The Monitor Audit endpoint returns audit information about the selected monitor, sorted from most to least recent.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/audit
curl -X GET "https://api.crimsonhexagon.com/api/monitor/audit?auth=tokenhere&id=123456789"
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

id
int64
required

id of the monitor to be audited

 

Possible Audit Events

ENABLED
DISABLED
RESET
PARTIAL_RESET
REMOVED
EDITED
TRAINED
UI_TWITTER_EXPORT
Suggest Edits

Monitor Detail

Returns detailed metadata about the selected monitor, including category metadata.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/detail
curl -X GET -H "https://api.crimsonhexagon.com/api/monitor/detail?auth=tokenhere&id=123456789"
A binary file was returned

You couldn't be authenticated

{
  "id": 3951144044,
  "name": "Boston Globe",
  "type": "SOCIAL",
  "enabled": true,
  "resultsStart": "2016-01-01T00:00:00",
  "resultsEnd": "2016-08-26T00:00:00",
  "keywords": "@bostonglobe OR authorUsername:@bostonglobe",
  "languages": {
    "values": [],
    "type": "include"
  },
  "geolocations": {
    "values": [],
    "type": "include"
  },
  "gender": "",
  "sources": [
    "Twitter"
  ],
  "timezone": "GMT",
  "teamName": "Tyler Mills",
  "tags": [],
  "subfilters": [],
  "categories": [
    {
      "status": "red",
      "id": 3951144046,
      "name": "Basic Positive",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 100
    },
    {
      "status": "red",
      "id": 3951144047,
      "name": "Basic Neutral",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 101
    },
    {
      "status": "red",
      "id": 3951144048,
      "name": "Basic Negative",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 102
    }
  ],
  "emotions": [
    {
      "status": "red",
      "id": 3951144055,
      "name": "Joy",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 103
    },
    {
      "status": "red",
      "id": 3951144053,
      "name": "Sadness",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 104
    },
    {
      "status": "red",
      "id": 3951144050,
      "name": "Neutral",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 105
    },
    {
      "status": "red",
      "id": 3951144056,
      "name": "Disgust",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 106
    },
    {
      "status": "red",
      "id": 3951144052,
      "name": "Anger",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 107
    },
    {
      "status": "red",
      "id": 3951144054,
      "name": "Surprise",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 108
    },
    {
      "status": "red",
      "id": 3951144051,
      "name": "Fear",
      "trainingDocs": 0,
      "hidden": false,
      "sortOrder": 109
    }
  ],
  "status": "success"
}

Query Params

id
int64
required

id of the monitor being requested

 
Suggest Edits

Content Upload

You may use the Content Upload endpoint to upload documents for analysis. In the past, users have uploaded survey responses, proprietary content, and other types of data not available in the Crimson Hexagon data library. To use this endpoint, please contact support and they will create a new custom content type for you.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.crimsonhexagon.com/api/content/upload
{
  "items": [
    {
      "title": "Example Title",
      "date": "2010-01-26T16:14:00",
      "author": "me",
      "url": "http://www.crimsonhexagon.com/post1",
      "contents": "Example content",
      "language": "en",
      "type": "Your_Assigned_Content_Type_Name",
      "geolocation": {
        "id": "USA.NY"
      }
    },
    {
      "title": "ExampleTitle2",
      "date": "2010-01-26T16:14:01",
      "author": "me",
      "gender": "M",
      "url": "http://www.crimsonhexagon.com/post2",
      "contents": "Examplecontent2",
      "language": "en",
      "type": "Your_Assigned_Content_Type_Name",
      "geolocation": {
        "zipcode": "02210"
      }
    },
    {
      "title": "ExampleTitle3",
      "date": "2010-01-26T16:14:05",
      "author": "me",
      "age": 33,
      "url": "http://www.crimsonhexagon.com/post3",
      "contents": "Examplecontent2",
      "language": "en",
      "type": "Your_Assigned_Content_Type_Name",
      "geolocation": {
        "latitude": 42.3504621,
        "longitude": -71.0533528
      }
    }
  ]
}
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

items
object
 
items.title
string
required

the title of the document being uploaded

items.date
date
required

the creation date of the content

items.author
string
required

the creator of the content

items.url
string
required

the web location of this content

items.contents
string
required

the entire document contents

items.language
string
required

the source language

items.type
string
required

the defined name assigned to you

items.gender
string

the gender of the author

items.age
int32

the age of the author

items.geolocation
object
 
items.geolocation.id
string

any valid string from the geography metadata endpoints

items.geolocation.latitude
float

latitude of the author

items.geolocation.longitude
float

longitude of the author

items.geolocation.zipcode
string

US ZIP Code of the author

requestUsage
boolean

Request the API usage against your contracted usage.

 

You may upload a maximum of 1,000 documents per request with this endpoint.

Suggest Edits

Stream List

If enabled, this endpoint will list all available Realtime Streams for a team.
Please note that the Realtime Streams API is not automatically enabled for API users. To gain access to the Realtime Streams API, please contact your CSM.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/stream/list/
curl --request GET \
  --url 'https://api.crimsonhexagon.com/api/stream/list/?auth=auth&teamid=teamid'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.crimsonhexagon.com/api/stream/list/',
  qs: 
   { auth: 'auth',
     teamid: 'teamid' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.crimsonhexagon.com/api/stream/list/?auth=auth&teamid=teamid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.crimsonhexagon.com/api/stream/list/?auth=auth&teamid=teamid");

xhr.send(data);
import requests

url = "https://api.crimsonhexagon.com/api/stream/list/"

querystring = {"auth":"auth","teamid":"teamid"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    “streams”: [
        {
            “id”: 123456,
            “name”: “Test Stream",
            “teamName”: “Test Team”,
            “monitors”: [
                {
                    “id”: 7899999,
                    “name”: “Apple”,
                    “description”: “”,
                    “type”: “OPINION”,
                    “enabled”: true,
                    “keywords”: \”iPhone\“”,
                    “languages”: {
                        “values”: [],
                        “type”: “include”
                    },
                    “geolocations”: {
                        “values”: [],
                        “type”: “include”
                    },
                    “gender”: “”,
                    “sources”: [
                        “Twitter”
                    ],
                    “timezone”: “GMT”,
                    “teamName”: “Test Team”,
                    “tags”: [],
                    “subfilters”: [],
                    “categories”: [
                        {
                            "status": "green",
                            "id": 4358322628,
                            "name": "Satisfied",
                            "trainingDocs": 23,
                            "hidden": false,
                            "sortOrder": 1,
                            "group": "General Positive",
                            "groupId": 4358322629
                        },
                        {
                            "status": "yellow",
                            "id": 4358322627,
                            "name": "Hard Drive",
                            "trainingDocs": 10,
                            "hidden": false,
                            "sortOrder": 2,
                            "group": "Negative",
                            "groupId": 4358322626
                        }               
                    ],
                    “emotions”: []
                }
            ]
        }
    ],
    "status":"success"
}
{
    “streams”: [
        {
            “id”: 123456,
            “name”: “Test Stream",
            “teamName”: “Test Team”,
            “monitors”: [
                {
                    “id”: 7899999,
                    “name”: “Apple”,
                    “description”: “”,
                    “type”: “BUZZ”,
                    “enabled”: true,
                    “keywords”: \”iPhone\“”,
                    “languages”: {
                        “values”: [],
                        “type”: “include”
                    },
                    “geolocations”: {
                        “values”: [],
                        “type”: “include”
                    },
                    “gender”: “”,
                    “sources”: [
                        “Twitter”
                    ],
                    “timezone”: “GMT”,
                    “teamName”: “Test Team”,
                    “tags”: [],
                    “subfilters”: [],
                    “categories”: [
                        {
                            “status”: “red”,
                            “id”: 4763388610,
                            “name”: “Basic Positive”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 100
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388608,
                            “name”: “Basic Neutral”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 101
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388606,
                            “name”: “Basic Negative”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 102
                        }
                    ],
                    “emotions”: [
                        {
                            “status”: “red”,
                            “id”: 4763388609,
                            “name”: “Joy”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 103
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388603,
                            “name”: “Sadness”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 104
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388602,
                            “name”: “Neutral”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 105
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388605,
                            “name”: “Disgust”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 106
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388611,
                            “name”: “Anger”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 107
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388607,
                            “name”: “Surprise”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 108
                        },
                        {
                            “status”: “red”,
                            “id”: 4763388604,
                            “name”: “Fear”,
                            “trainingDocs”: 0,
                            “hidden”: false,
                            “sortOrder”: 109
                        }
                    ]
                }
            ]
        }
    ],
    "status":"success"
}

Query Params

auth
string
required
teamid
int64
required

the id of the team, available via the team list endpoint

 
Suggest Edits

Stream Posts

If enabled, this endpoint will return all posts available in a Realtime Stream enhanced with sentiment/emotion or BrightView categorizations, as well as image classifications (logo or object recognition) for image-enabled monitors.
Please note that the Realtime Streams API is not automatically enabled for API users. To gain access to the Realtime Streams API, please contact your CSM.
Posts will be available for consumption for a 4-day period from when they initially become available.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/stream/streamid/posts
curl --request GET \
  --url 'https://api.crimsonhexagon.com/api/stream/streamid/posts?auth=auth'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.crimsonhexagon.com/api/stream/streamid/posts',
  qs: { auth: 'auth' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.crimsonhexagon.com/api/stream/streamid/posts?auth=auth")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.crimsonhexagon.com/api/stream/streamid/posts?auth=auth");

xhr.send(data);
import requests

url = "https://api.crimsonhexagon.com/api/stream/streamid/posts"

querystring = {"auth":"auth"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "posts": [
        {
            "url": "http://twitter.com/ItsTrizzyDuce/status/915738271996628993",
            "title": "",
            "type": "Twitter",
            "location": "Cleveland, OH, USA",
            "geolocation": {
                "id": "USA.OH.Cleveland",
                "name": "Cleveland",
                "country": "USA",
                "state": "OH",
                "city": "Cleveland"
            },
            "language": "en",
            "authorKlout": 40,
            "assignedCategoryId": 7091079318,
            "assignedEmotionId": 7091079311,
            "categoryScores": [
                {
                    "categoryId": 7091079307,
                    "categoryName": "Basic Positive",
                    "score": 0.15
                },
                {
                    "categoryId": 7091079317,
                    "categoryName": "Basic Negative",
                    "score": 0.02
                },
                {
                    "categoryId": 7091079318,
                    "categoryName": "Basic Neutral",
                    "score": 0.83
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 7091079308,
                    "emotionName": "Surprise",
                    "score": 0.01
                },
                {
                    "emotionId": 7091079309,
                    "emotionName": "Fear",
                    "score": 0
                },
                {
                    "emotionId": 7091079311,
                    "emotionName": "Neutral",
                    "score": 0.85
                },
                {
                    "emotionId": 7091079312,
                    "emotionName": "Anger",
                    "score": 0
                },
                {
                    "emotionId": 7091079313,
                    "emotionName": "Sadness",
                    "score": 0.02
                },
                {
                    "emotionId": 7091079314,
                    "emotionName": "Joy",
                    "score": 0.11
                },
                {
                    "emotionId": 7091079316,
                    "emotionName": "Disgust",
                    "score": 0
                }
            ],
            "imageInfo": [],
            "monitorId": 7091079306,
            "guid": "915738271996628993",
            "parentGuid": "915731207689785345",
            "engagementType": "RETWEET",
            "documentsUrls": [
                "http://screenrant.com/guardians-galaxy-adam-warlock-marvel-legacy/"
            ],
            "mediaUrls": [
                "http://pbs.twimg.com/media/DLVUrbfXkAAS9R3.jpg"
            ]
        }
    ],
    "totalPostsAvailable": 1,
    "status": "success"
{"message":"Unauthorized","status":"error"}
{"message":"Required parameter 'auth' not provided","status":"error"}
{"message":"Full authentication is required to access this resource","status":"error"}

{"message":"Access is denied","status":"error"}
{"message":"Method GET is not supported for /api/stream/posts. Please use: DELETE","status":"error"}
{"message":"Stream cannot be accessed. Reason is ‘Stream does not exist’","status":"error"}
{
    "posts": [
        {
            "url": "http://www.facebook.com/143666524748/posts/10156356673014749?comment_id=10156357279979749",
            "date": "2017-10-16T12:56:17",
            "contents": "Odd, this hasn’t made the BBC live business updates yet, also the pound is up this morning as is the FTSE 100.",
            "title": "The Telegraph Wall - Reply to: Global banks have been left stunned by the massive write-down.",
            "type": "Facebook",
            "language": "en",
            "authorGender": "M",
            "assignedCategoryId": 7910673341,
            "assignedEmotionId": 0,
            "categoryScores": [
                {
                    "categoryId": 7910673346,
                    "categoryName": "Basic Negative",
                    "score": 0.12
                },
                {
                    "categoryId": 7910673343,
                    "categoryName": "Basic Positive",
                    "score": 0.13
                },
                {
                    "categoryId": 7910673341,
                    "categoryName": "Basic Neutral",
                    "score": 0.75
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 7910673344,
                    "emotionName": "Fear",
                    "score": 0.12
                },
                {
                    "emotionId": 7910673345,
                    "emotionName": "Surprise",
                    "score": 0.17
                },
                {
                    "emotionId": 7910673338,
                    "emotionName": "Anger",
                    "score": 0.25
                },
                {
                    "emotionId": 7910673339,
                    "emotionName": "Neutral",
                    "score": 0.11
                },
                {
                    "emotionId": 7910673337,
                    "emotionName": "Joy",
                    "score": 0.26
                },
                {
                    "emotionId": 7910673342,
                    "emotionName": "Disgust",
                    "score": 0.04
                },
                {
                    "emotionId": 7910673340,
                    "emotionName": "Sadness",
                    "score": 0.05
                }
            ],
            "imageInfo": [],
            "monitorId": 7910673336,
            "guid": "10156356673014749_10156357279979749",
            "parentGuid": "143666524748_10156356673014749",
            "engagementType": "COMMENT",
            "pageId": "330250343871"    
        }
    ],
    "totalPostsAvailable": 1,
    "status": "success"
{
    "posts": [
        {
            "url": "https://www.instagram.com/p/BaZpubbBx8t/?comment=17903714536058557",
            "date": "2017-10-18T19:20:28",
            "author": "Alajmani",
            "contents": "#photo #photoshoot #photoshop #photos #pictureday #picture #pictures #tv #show #frame #fox #cnn #bbc #media #abc #us #usa #un #world #people",
            "title": "ajmani150 - null",
            "type": "Instagram",
            "language": "en",
            "assignedCategoryId": 7910713978,
            "assignedEmotionId": 7910713987,
            "categoryScores": [
                {
                    "categoryId": 7910713978,
                    "categoryName": "Basic Neutral",
                    "score": 0.68
                },
                {
                    "categoryId": 7910713979,
                    "categoryName": "Basic Negative",
                    "score": 0.01
                },
                {
                    "categoryId": 7910713982,
                    "categoryName": "Basic Positive",
                    "score": 0.31
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 7910713986,
                    "emotionName": "Anger",
                    "score": 0.03
                },
                {
                    "emotionId": 7910713987,
                    "emotionName": "Neutral",
                    "score": 0.75
                },
                {
                    "emotionId": 7910713984,
                    "emotionName": "Joy",
                    "score": 0.02
                },
                {
                    "emotionId": 7910713985,
                    "emotionName": "Fear",
                    "score": 0.02
                },
                {
                    "emotionId": 7910713983,
                    "emotionName": "Disgust",
                    "score": 0.05
                },
                {
                    "emotionId": 7910713980,
                    "emotionName": "Sadness",
                    "score": 0.09
                },
                {
                    "emotionId": 7910713981,
                    "emotionName": "Surprise",
                    "score": 0.04
                }
            ],
            "imageInfo": [],
            "monitorId": 7910713977,
            "guid": "17903714536058557",
            "parentGuid": "1628516250718510893_4393681610",
            "engagementType": "COMMENT",
            "authorProfileId": "4393681610"
        }
    ],
    "totalPostsAvailable": 1,
    "status": "success"
{
    "posts": [
        {
            "url": "https://www.instagram.com/p/BcKWQ4ilpe-/",
            "date": "2017-12-01T13:42:14",
            "author": "New Age Classics (Ireland)",
            "contents": "Despite it being the winter months, keep the bright colours Aplenty🔥🔥\n-\n-\n-\n-\n-\n-\n-\n-\n-\n#tommyhilfiger #thriftstorefinds #vintageclothing #supreme #bape #nike #poloralphlauren #adidas #tommyflag #vintageforsale #tommytuesday #thrifting #tommyheat #tommygirl #90s #90sfashion #tommyhilfigertalk #tommyfiend #streetfashion #ootd #80s #90s #polobear #vintagetommyhilfiger #tommyjacket #ootd #hypebeast #like4like #l4l",
            "title": "newageclassics__ - Despite it being the winter months, keep the bright colours Aplenty🔥🔥\n-\n-\n-\n-\n-\n-\n-\n-\n-\n#tommyhilfiger #thriftstorefinds #vintageclothing #supreme #bape #nike #poloralphlauren #adidas #tommyflag #vintageforsale #tommytuesday #thrifting #tommyheat #tommygirl #90s #90sfashion #tommyhilfigertalk #tommyfiend #streetfashion #ootd #80s #90s #polobear #vintagetommyhilfiger #tommyjacket #ootd #hypebeast #like4like #l4l",
            "type": "Instagram",
            "language": "en",
            "assignedCategoryId": 8456534918,
            "assignedEmotionId": 8456534921,
            "categoryScores": [
                {
                    "categoryId": 8456534920,
                    "categoryName": "Basic Neutral",
                    "score": 0.26
                },
                {
                    "categoryId": 8456534922,
                    "categoryName": "Basic Negative",
                    "score": 0.03
                },
                {
                    "categoryId": 8456534918,
                    "categoryName": "Basic Positive",
                    "score": 0.7
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 8456534924,
                    "emotionName": "Fear",
                    "score": 0.01
                },
                {
                    "emotionId": 8456534921,
                    "emotionName": "Neutral",
                    "score": 0.5
                },
                {
                    "emotionId": 8456534923,
                    "emotionName": "Sadness",
                    "score": 0.12
                },
                {
                    "emotionId": 8456534917,
                    "emotionName": "Joy",
                    "score": 0.18
                },
                {
                    "emotionId": 8456534916,
                    "emotionName": "Surprise",
                    "score": 0.03
                },
                {
                    "emotionId": 8456534919,
                    "emotionName": "Disgust",
                    "score": 0.13
                },
                {
                    "emotionId": 8456534915,
                    "emotionName": "Anger",
                    "score": 0.04
                }
            ],
            "imageInfo": [
                {
                    "url": "https://scontent.cdninstagram.com/t51.2885-15/s640x640/sh0.08/e35/24175290_1963386173679460_2510037174783574016_n.jpg",
                    "brands": [
                        {
                            "brandId": "172",
                            "brand": "Adidas",
                            "size": "tiny",
                            "score": 1
                        }
                    ],
                    "objects": [
                        {
                            "score": 0.97787,
                            "classId": 3003,
                            "className": "Yellow"
                        },
                        {
                            "score": 0.95303,
                            "classId": 3584,
                            "className": "Jacket"
                        },
                        {
                            "score": 0.91877,
                            "classId": 3731,
                            "className": "Clothing"
                        },
                        {
                            "score": 0.90033,
                            "classId": 3546,
                            "className": "T-shirt"
                        },
                        {
                            "score": 0.89645,
                            "classId": 3444,
                            "className": "Outerwear"
                        },
                        {
                            "score": 0.88147,
                            "classId": 3812,
                            "className": "Product"
                        }
                    ]
                }
            ],
            "monitorId": 8456534914,
            "guid": "1660237329884157886_4936136214",
            "engagementtype": "POST",
            "authorUsername": "newageclassics__",
            "authorProfileId": "4936136214"
        },
        {
            "url": "http://twitter.com/LuthfiRamansya/status/936617509960089600",
            "date": "2017-12-01T15:26:30",
            "title": "",
            "type": "Twitter",
            "location": "Jakarta, Jakarta Raya, IDN",
            "geolocation": {
                "id": "IDN.Jakarta Raya.Jakarta",
                "name": "Jakarta",
                "country": "IDN",
                "state": "Jakarta Raya",
                "city": "Jakarta"
            },
            "language": "en",
            "authorKlout": 42,
            "authorPosts": 64993,
            "authorsFollowing": 439,
            "authorsFollowers": 747,
            "assignedCategoryId": 8456534920,
            "assignedEmotionId": 8456534921,
            "categoryScores": [
                {
                    "categoryId": 8456534920,
                    "categoryName": "Basic Neutral",
                    "score": 0.63
                },
                {
                    "categoryId": 8456534922,
                    "categoryName": "Basic Negative",
                    "score": 0.02
                },
                {
                    "categoryId": 8456534918,
                    "categoryName": "Basic Positive",
                    "score": 0.35
                }
            ],
            "emotionScores": [
                {
                    "emotionId": 8456534924,
                    "emotionName": "Fear",
                    "score": 0
                },
                {
                    "emotionId": 8456534921,
                    "emotionName": "Neutral",
                    "score": 0.89
                },
                {
                    "emotionId": 8456534923,
                    "emotionName": "Sadness",
                    "score": 0.02
                },
                {
                    "emotionId": 8456534917,
                    "emotionName": "Joy",
                    "score": 0.03
                },
                {
                    "emotionId": 8456534916,
                    "emotionName": "Surprise",
                    "score": 0.03
                },
                {
                    "emotionId": 8456534919,
                    "emotionName": "Disgust",
                    "score": 0.01
                },
                {
                    "emotionId": 8456534915,
                    "emotionName": "Anger",
                    "score": 0.01
                }
            ],
            "imageInfo": [
                {
                    "url": "http://pbs.twimg.com/media/DP9E0z2XUAA4Kun.jpg",
                    "brands": [
                        {
                            "brandId": "172",
                            "brand": "Adidas",
                            "size": "small",
                            "score": 1
                        }
                    ],
                    "objects": [
                        {
                            "score": 0.98586,
                            "classId": 4048,
                            "className": "Ball"
                        },
                        {
                            "score": 0.98428,
                            "classId": 3713,
                            "className": "Sphere"
                        },
                        {
                            "score": 0.95074,
                            "classId": 3317,
                            "className": "Earth"
                        },
                        {
                            "score": 0.87343,
                            "classId": 3899,
                            "className": "Cobalt Blue"
                        }
                    ]
                }
            ],
            "monitorId": 8456534914,
            "guid": "936617509960089600",
            "parentguid": "936542924266930176",
            "engagementtype": "RETWEET",
            "mediaUrls": [
                "http://pbs.twimg.com/media/DP9E0z2XUAA4Kun.jpg"
            ]
        }
   ],
    "totalPostsAvailable": 2,
    "status": "success"
}

Path Params

streamid
int64
required

the id of the stream containing the posts, available via the stream list endpoint

Query Params

auth
string
required
count
int32

the count of posts to retrieve from the stream, max = 100

 
Suggest Edits

Analysis Request

Submit a query task against 24 hours of social data.

We have annual package pricing based on the number of queries that you would like to run. A "query" is a request for data about a keyword, keyword phrase, or complex boolean for a 24hr period. (So to get volume metrics for "nike" for the last week in May, you would need to run 7 queries - one for each day with the same keyword = "nike"; to get volume metrics for "nike OR swoosh OR 'just do it' " for the last week in May, you would also need to run 7 queries).

We count queries submitted to the API that have successfully generated results against your quota. Queries that result in an error being generated, or which do not create a result which can be successfully retrieved are not counted. Please note: queries that generate zero results (i.e. found no matching posts) are counted as these have successfully searched our data stores and processed your request, and these will generate a result which can be retrieved showing the zero volume.

 

Query Auth

 Authentication is required for this endpoint.
posthttps://api.crimsonhexagon.com/api/results
{
  "analysis": [
    "volume",
    "sentiment",
    "emotion",
    "affinity",
    "gender",
    "age",
    "ethnicity",
    "location",
    "source",
    "reach"
  ],
  "keywords": "iPhone",
  "languages": {
    "type": "include",
    "values": [
      "EN"
    ]
  },
  "gender": {
        "type": "include",
        "values": ["M"]
   },
  "locations": {
    "type": "exclude",
    "values": [
    	"JPN"
    ]
  },
  "sources": [
    "TWITTER",
    "FACEBOOK",
    "TUMBLR",
    "INSTAGRAM",
    "BLOGS",
    "REVIEWS",
    "GOOGLE_PLUS",
    "NEWS",
    "YOUTUBE",
    "FORUMS",
    "CUSTOM:myPubType1",
    "CUSTOM:myPubType2"
  ],
  "startDate": "2016-09-20T00:00:00",
  "endDate": "2016-09-21T00:00:00",
  "timezone": "America/New_York",
  "requestUsage": true
}
curl -X POST -H "Content-Type: application/json" -g -d '{
  "analysis": [
    "volume",
    "sentiment",
    "gender",
    "age",
    "ethnicity",
    "location",
    "source"
  ],
  "keywords": "iPhone",
  "languages": {
    "type": "include",
    "values": [
      "en"
    ]
  },
  "locations": {
    "type": "exclude",
    "values": [
      "USA",
      "CAN"
    ]
  },
  "sources": [
    "TWITTER"
  ],
  "startDate": "2016-06-01T00:00:00",
  "endDate": "2016-06-02T00:00:00",
  "timezone": "America/New_York"
}' "https://api.crimsonhexagon.com/api/results?auth=tokenhere"
A binary file was returned

You couldn't be authenticated

{
  "status": "WAITING",
  "resultId": 4249597151,
  "retrieveAt": "2016-09-28T20:31:51+0000",
  "retrieveAtMillis": 1475094711540,
  "resultsUri": "https://api.crimsonhexagon.com/api/results/4249597151?auth=123",
  "request": {
    "analysis": [
      "volume",
      "sentiment",
      "emotion",
      "gender",
      "affinity",
      "age",
      "ethnicity",
      "location",
      "source",
      "reach"
    ],
    "startDate": "2016-09-20T00:00:00",
    "endDate": "2016-09-21T00:00:00",
    "timezone": "America/New_York",
    "sources": [
      "TWITTER",
      "FACEBOOK",
      "TUMBLR",
      "INSTAGRAM",
      "BLOGS",
      "REVIEWS",
      "GOOGLE_PLUS",
      "NEWS",
      "YOUTUBE",
      "FORUMS"
    ],
    "keywords": "iPhone",
    "languages": {
      "type": "include",
      "values": [
        "en"
      ]
    },
    "locations": {
      "type": "exclude",
      "values": [
        "JPN"
      ]
    }
  }
}
{
  "resultId": 4249597151,
  "status": "DONE",
  "analysis": {
    "sentiment": {
      "positive": {
        "proportion": 0.2575,
        "count": 110673
      },
      "neutral": {
        "proportion": 0.5982,
        "count": 257105
      },
      "negative": {
        "proportion": 0.1443,
        "count": 62020
      }
    },
    "volume": {
      "BLOGS": 1721,
      "FORUMS": 50860,
      "REVIEWS": 662,
      "NEWS": 4369,
      "FACEBOOK": 8424,
      "TWITTER": 255237,
      "YOUTUBE": 67013,
      "GOOGLE_PLUS": 28,
      "INSTAGRAM": 0,
      "TUMBLR": 41484
    },
    "emotion": {
      "Joy": {
        "proportion": 0.1186,
        "count": 51730
      },
      "Sadness": {
        "proportion": 0.0213,
        "count": 9290
      },
      "Neutral": {
        "proportion": 0.7656,
        "count": 333933
      },
      "Disgust": {
        "proportion": 0.003,
        "count": 1309
      },
      "Anger": {
        "proportion": 0.0879,
        "count": 38339
      },
      "Surprise": {
        "proportion": 0.0003,
        "count": 131
      },
      "Fear": {
        "proportion": 0.0033,
        "count": 1439
      }
    },
    "gender": {
      "F": 51309,
      "M": 72810
    },
    "age": {
      "ZERO_TO_SEVENTEEN": 6415,
      "THIRTYFIVE_AND_OVER": 12046,
      "TWENTYFIVE_TO_THIRTYFOUR": 1789,
      "EIGHTEEN_TO_TWENTYFOUR": 4495
    },
    "ethnicity": {
      "White": 1186,
      "Latino": 155,
      "Black": 317,
      "Asian": 492
    },
    "location": {
      "totalVolume": 0,
      "data": [
        {
          "info": {
            "id": "NOR",
            "name": "Norway",
            "country": "NOR"
          },
          "volume": 87,
          "perMillion": 18.60443234562331
        },
        {
          "info": {
            "id": "IDN",
            "name": "Indonesia",
            "country": "IDN"
          },
          "volume": 4103,
          "perMillion": 17.076513961567198
        },
        {
          "info": {
            "id": "BWA",
            "name": "Botswana",
            "country": "BWA"
          },
          "volume": 43,
          "perMillion": 21.59853250528913
        }
      ]
    },
    "affinity": [
      {
        "affinity": 99.97753,
        "localCount": 19,
        "localPercentage": 0.04491726,
        "twitterCount": 1,
        "twitterPercentage": 0.0000050490517,
        "segmentId": 13,
        "segmentName": "Crystal Palace Fc",
        "relevance": 40.84496
      }
    ],
    "reach": 123,
    "source": {
      "craftster.org": 87,
      "mazdaspeedforums.org": 44,
      "bodybuilding.com": 87,
      "10thousandcouples.com": 109,
      "11freunde.de": 44,
      "diariocatolico.net": 109,
      "zpost.com": 44,
      "halforums.com": 87,
      "gsmhosting.com": 87,
      "boards.ie": 175,
      "digitaltrends.com": 73,
      "roadbikereview.com": 44,
      "rolexforums.com": 568,
      "thevillagessuntimes.com": 73,
      "audi-sport.net": 87,
      "kait8.com": 73,
      "att.com": 262,
      "musicplayer.com": 44,
      "jeuxactu.com": 131,
      "roro30.com": 44,
      "facebook.com": 8424,
      "amazon.com": 56,
      "e90post.com": 87,
      "thedenverchannel.com": 73,
      "cruisecritic.com": 786,
      "bigfooty.com": 211,
      "tripadvisor.com": 47,
      "tidefans.com": 87
    }
  },
  "request": {
    "analysis": [
      "volume",
      "sentiment",
      "emotion",
      "gender",
      "age",
      "affinity",
      "ethnicity",
      "location",
      "source"
    ],
    "startDate": "2016-09-20T00:00:00",
    "endDate": "2016-09-21T00:00:00",
    "timezone": "America/New_York",
    "sources": [
      "TWITTER",
      "FACEBOOK",
      "TUMBLR",
      "INSTAGRAM",
      "BLOGS",
      "REVIEWS",
      "GOOGLE_PLUS",
      "NEWS",
      "YOUTUBE",
      "FORUMS"
    ],
    "keywords": "iPhone",
    "languages": {
      "type": "include",
      "values": [
        "en"
      ]
    },
    "locations": {
      "type": "exclude",
      "values": [
        "JPN"
      ]
    }
  }
}

Body Params

analysis
array of strings
required

Available types include: volume, emotion, sentiment, gender, age, ethnicity, location, source, affinity, reach (affinity and reach are Twitter only)

keywords
string
required

Boolean logic to utilize for analysis. Ensure you are escaping nested quotes with a \ character.

languages
object
 
languages.type
string
required

Option to include or exclude selected languages.values for this analysis.

languages.values
array of strings
required
locations
object
 
locations.type
string

Option to include or exclude selected locations.values for this analysis.

locations.values
array of strings

Array of locations to include or exclude.

gender
object
 
gender.type
string

Option to include or exclude selected gender.values for this analysis.

gender.values
array of strings

Array of genders to include or exclude.

sources
array of strings
required

Available Types: FACEBOOK, TWITTER, TUMBLR, GOOGLE_PLUS, NEWS, REVIEWS, YOUTUBE, BLOGS, FORUMS, CUSTOM:pubType

startDate
date
required

Start time. Range is limited to 24 hours.

endDate
date
required

End time. Range is limited to 24 hours.

timezone
string
required

The timezone to utilize for this analysis.

requestUsage
boolean

Request the API usage against your contracted usage.

 

Retry Logic

If a user successfully submits an Analysis API request which encounters an error during the analysis process itself, the analysis will be retried up to 5 times (for a total of 6 attempts including the initial attempt)

Each failed attempt will result in a longer wait time before the next retry is attempted to provide more time for the issue to be resolved before retrying

The wait time for each attempt is as follows:

  • Initial failure will be retried after 1 minute
  • 1st retry failure will be retried after 3 minutes
  • 2nd retry failure will be retried after 5 minutes
  • 3rd retry failure will be retried after 10 minutes
  • 4th failure will be retried after 20 minutes
  • 5th failure will result in the analysis request being skipped and the user will need to submit a new request

If a call to the results URL is made prior to the analysis being successfully completed, the user will be provided (within the API response) a retrieval time that coincides with the applicable wait period or notified of the skipped state if the 5th retry failure has occurred

Custom Content Analysis

You may perform an analysis on custom content sources uploaded via the Crimson Hexagon Upload API by using the following syntax:

"sources": [ "FACEBOOK", "CUSTOM:pubTypeName" ]

You may provide multiple custom data sources in a request. But all the sources should be under the same team.

Support Languages for Filtering

Language
2 Character Code

Arabic

AR

Azerbaijani

AZ

Basque

EU

Bulgarian

BG

Catalan

CA

Chinese

ZH

Croatian

HR

Czech

CS

Danish

DA

Dutch

NL

English

EN

Finnish

FI

French

FR

German

DE

Greek

EL

Hebrew

HE

Hindi

HI

Hungarian

HU

Indonesian

ID

Italian

IT

Japanese

JA

Kazakh

KK

Korean

KO

Kurdish

KU

Lithuanian

LT

Malay

MS

Norwegian

NO

Persian

FA

Polish

PL

Portuguese

PT

Romanian

RO

Russian

RU

Serbian

SR

Slovak

SK

Slovene

SL

Spanish

ES

Swedish

SV

Thai

TH

Turkish

TR

Urdu

UR

Async?

Depending on the complexity of the analysis and other factors, responses will either be asynchronous or synchronous. If results are ready upon the initial request, an HTTP status code 200 will be returned immediately to the POST call with a status of DONE. If not, you will receive a status of WAITING and a resultId that you can make a GET request against.

Suggest Edits

Analysis Results

Retrieve the status of the analysis request and the results.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/results/resultId
curl -X GET "https://api.crimsonhexagon.com/api/results/9876543210?auth=tokenhere"
A binary file was returned

You couldn't be authenticated

{
  "resultId": 4249597151,
  "status": "DONE",
  "analysis": {
    "sentiment": {
      "positive": {
        "proportion": 0.2575,
        "count": 110673
      },
      "neutral": {
        "proportion": 0.5982,
        "count": 257105
      },
      "negative": {
        "proportion": 0.1443,
        "count": 62020
      }
    },
    "volume": {
      "BLOGS": 1721,
      "FORUMS": 50860,
      "REVIEWS": 662,
      "NEWS": 4369,
      "FACEBOOK": 8424,
      "TWITTER": 255237,
      "YOUTUBE": 67013,
      "GOOGLE_PLUS": 28,
      "INSTAGRAM": 0,
      "TUMBLR": 41484
    },
    "emotion": {
      "Joy": {
        "proportion": 0.1186,
        "count": 51730
      },
      "Sadness": {
        "proportion": 0.0213,
        "count": 9290
      },
      "Neutral": {
        "proportion": 0.7656,
        "count": 333933
      },
      "Disgust": {
        "proportion": 0.003,
        "count": 1309
      },
      "Anger": {
        "proportion": 0.0879,
        "count": 38339
      },
      "Surprise": {
        "proportion": 0.0003,
        "count": 131
      },
      "Fear": {
        "proportion": 0.0033,
        "count": 1439
      }
    },
    "gender": {
      "F": 51309,
      "M": 72810
    },
    "age": {
      "ZERO_TO_SEVENTEEN": 6415,
      "THIRTYFIVE_AND_OVER": 12046,
      "TWENTYFIVE_TO_THIRTYFOUR": 1789,
      "EIGHTEEN_TO_TWENTYFOUR": 4495
    },
    "ethnicity": {
      "White": 1186,
      "Latino": 155,
      "Black": 317,
      "Asian": 492
    },
    "location": {
      "totalVolume": 0,
      "data": [
        {
          "info": {
            "id": "NOR",
            "name": "Norway",
            "country": "NOR"
          },
          "volume": 87,
          "perMillion": 18.60443234562331
        },
        {
          "info": {
            "id": "IDN",
            "name": "Indonesia",
            "country": "IDN"
          },
          "volume": 4103,
          "perMillion": 17.076513961567198
        },
        {
          "info": {
            "id": "BWA",
            "name": "Botswana",
            "country": "BWA"
          },
          "volume": 43,
          "perMillion": 21.59853250528913
        }
      ]
    },
    "affinity": [
      {
        "affinity": 99.97753,
        "localCount": 19,
        "localPercentage": 0.04491726,
        "twitterCount": 1,
        "twitterPercentage": 0.0000050490517,
        "segmentId": 13,
        "segmentName": "Crystal Palace Fc",
        "relevance": 40.84496
      }
    ],
    "reach": 123,
    "source": {
      "craftster.org": 87,
      "mazdaspeedforums.org": 44,
      "bodybuilding.com": 87,
      "10thousandcouples.com": 109,
      "11freunde.de": 44,
      "diariocatolico.net": 109,
      "zpost.com": 44,
      "halforums.com": 87,
      "gsmhosting.com": 87,
      "boards.ie": 175,
      "digitaltrends.com": 73,
      "roadbikereview.com": 44,
      "rolexforums.com": 568,
      "thevillagessuntimes.com": 73,
      "audi-sport.net": 87,
      "kait8.com": 73,
      "att.com": 262,
      "musicplayer.com": 44,
      "jeuxactu.com": 131,
      "roro30.com": 44,
      "facebook.com": 8424,
      "amazon.com": 56,
      "e90post.com": 87,
      "thedenverchannel.com": 73,
      "cruisecritic.com": 786,
      "bigfooty.com": 211,
      "tripadvisor.com": 47,
      "tidefans.com": 87
    }
  },
  "request": {
    "analysis": [
      "volume",
      "sentiment",
      "emotion",
      "affinity",
      "gender",
      "age",
      "ethnicity",
      "location",
      "source",
      "reach"
    ],
    "startDate": "2016-09-20T00:00:00",
    "endDate": "2016-09-21T00:00:00",
    "timezone": "America/New_York",
    "sources": [
      "TWITTER",
      "FACEBOOK",
      "TUMBLR",
      "INSTAGRAM",
      "BLOGS",
      "REVIEWS",
      "GOOGLE_PLUS",
      "NEWS",
      "YOUTUBE",
      "FORUMS"
    ],
    "keywords": "iPhone",
    "languages": {
      "type": "include",
      "values": [
        "en"
      ]
    },
    "locations": {
      "type": "exclude",
      "values": [
        "JPN"
      ]
    }
  }
}
{
  "status": "WAITING",
  "resultId": 4249597151,
  "retrieveAt": "2016-09-28T20:31:51+0000",
  "retrieveAtMillis": 1475094711540,
  "resultsUri": "https://api.crimsonhexagon.com/api/results/4249597151?auth=123",
  "request": {
    "analysis": [
      "volume",
      "sentiment",
      "affinity",
      "emotion",
      "gender",
      "age",
      "ethnicity",
      "location",
      "source",
      "reach"
    ],
    "startDate": "2016-09-20T00:00:00",
    "endDate": "2016-09-21T00:00:00",
    "timezone": "America/New_York",
    "sources": [
      "TWITTER",
      "FACEBOOK",
      "TUMBLR",
      "INSTAGRAM",
      "BLOGS",
      "REVIEWS",
      "GOOGLE_PLUS",
      "NEWS",
      "YOUTUBE",
      "FORUMS"
    ],
    "keywords": "iPhone",
    "languages": {
      "type": "include",
      "values": [
        "en"
      ]
    },
    "locations": {
      "type": "exclude",
      "values": [
        "JPN"
      ]
    }
  }
}

Path Params

resultId
int64
required

the identifier given for the analysis task, generated via the Analysis Request endpoint

 

Result Availability

Once results have been generated for your request, they are guaranteed for retrieval for up to 30 days. As such, we highly recommend storing the resultId after generating a request and using a separate process for gathering your results.

Response Fields & Values

Analysis Type
Analysis Categories
Values

sentiment

positive, neutral, negative

proportion, count

volume

FACEBOOK, TWITTER, TUMBLR, GOOGLE_PLUS, NEWS, REVIEWS, YOUTUBE, BLOGS, FORUMS

emotion

Joy, Sadness, Neutral, Disgust, Anger, Surprise, Fear

proportion, count

gender

F, M

age

ZERO_TO_SEVENTEEN, THIRTYFIVE_AND_OVER, TWENTYFIVE_TO_THIRTYFOUR, EIGHTEEN_TO_TWENTYFOUR

ethnicity

White, Latino, Black, Asian

location

volume, data, info.id, info.name, info.country

volume, perMillion

source

{'domain name': volume, 'domain name': volume, ...}
top 100 domains

volume

affinity

affinity, localCount, localPercentage, twitterCount, twitterPercentage, segmentId, segmentName,relevance

reach (Twitter reach also known as potential impressions)

volume

Suggest Edits

Team List

Returns a list of teams accessible to the requesting user.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/team/list
curl -X GET "https://api.crimsonhexagon.com/api/team/list?auth=tokenhere"
A binary file was returned

You couldn't be authenticated

{
  "teams": [
    {
      "id": 507581078,
      "name": "Acme"
    },
    {
      "id": 500793406,
      "name": "Bob's Used Cars"
    },
    {
      "id": 1283959240,
      "name": "Phones and Things"
    }
  ],
  "status": "success"
}
 
Suggest Edits

Monitor List

Returns a list of monitors accessible to the requesting or selected user along with metadata related to those monitors.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/monitor/list
curl -X GET "https://api.crimsonhexagon.com/api/monitor/list?auth=tokenhere&team=987654321"
A binary file was returned

You couldn't be authenticated

{
  "monitors": [
    {
      "id": 123456789,
      "name": "\"Customer Advocacy\"",
      "description": "",
      "type": "BUZZ",
      "enabled": false,
      "resultsStart": "2015-03-01T00:00:00",
      "resultsEnd": "2016-03-01T00:00:00",
      "keywords": "(\"CUSTOMER ADVOCACY\" OR \"ADVOCACY MARKETING\" OR \"CUSTOMER ADVOCATE\" OR \"CUSTOMER ADVOCATES\" OR \"ADVOCATE MARKETING\") AND -\"CUSTOMER SERVICE\"",
      "languages": {
        "values": [],
        "type": "include"
      },
      "geolocations": {
        "values": [],
        "type": "include"
      },
      "gender": "",
      "sources": [
        "Twitter",
        "Reviews",
        "Blogs",
        "Comments",
        "Forums",
        "News",
        "Tumblr"
      ],
      "timezone": "GMT",
      "teamName": "Crimson Hexagon",
      "tags": [],
      "subfilters": [
        {
          "id": 3400865665,
          "name": "Timestamp: 14:00 to 20:00",
          "parameters": "Timestamp: 14:00 to 20:00"
        },
        {
          "id": 3934382506,
          "name": "Keywords: dogs; Content Sources: Twitter; Categories: Basic Negative",
          "parameters": "Keywords: dogs; Content Sources: Twitter; Categories: Basic Negative"
        },
        {
          "id": 3732429287,
          "name": "Content Sources: Twitter",
          "parameters": "Content Sources: Twitter"
        },
        {
          "id": 3397798169,
          "name": "Timestamp: 11:00 to 15:00",
          "parameters": "Timestamp: 11:00 to 15:00"
        }
      ]
    }
  ]
}

Query Params

team
int64

id of the team to which the listed monitors belong

 
Suggest Edits

Geography

 

This collection of endpoints return the strings you may use within the Results and Analysis APIs to represent geographical locations.

Suggest Edits

Available Geography

Returns all the geographical locations that you may use to filter monitor results and to upload documents with location information.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/geography/info/all
curl -X GET "https://api.crimsonhexagon.com/api/geography/info/all?auth=tokenhere"
A binary file was returned

You couldn't be authenticated

{
  "resources": [
    {
      "id": "ABW",
      "name": "Aruba",
      "country": "ABW",
      "latitude": 12.516935,
      "longitude": -69.9742
    },
    {
      "id": "ABW.Aruba",
      "name": "Aruba",
      "country": "ABW",
      "state": "Aruba",
      "latitude": 12.516935,
      "longitude": -69.9742
    },
    {
      "id": "AFG",
      "name": "Afghanistan",
      "country": "AFG",
      "latitude": 33.836266,
      "longitude": 66.008446
    },
    ...
    ...
  ]
}
 
Suggest Edits

Available States

Returns all the states for a given country that you may use to filter monitor results and to upload documents with location information.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/geography/info/states
curl -X GET "https://api.crimsonhexagon.com/api/geography/info/states?auth=tokenhere&country=usa"
A binary file was returned

You couldn't be authenticated

{
  "resources": [
    {
      "id": "USA.AK",
      "name": "Alaska",
      "country": "USA",
      "state": "AK",
      "latitude": 64.260765,
      "longitude": -152.27791
    },
    {
      "id": "USA.AL",
      "name": "Alabama",
      "country": "USA",
      "state": "AL",
      "latitude": 32.78917,
      "longitude": -86.82873
    },
    ...
    ...
  ]
}

Query Params

country
string
required

the ISO 3166 3 letter country code

 
Suggest Edits

Available Cities

Returns all the cities or urban areas defined in the given country that you may use to filter monitor results and to upload documents with location information.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/geography/info/cities
curl -X GET "https://api.crimsonhexagon.com/api/geography/info/cities?auth=tokenhere&country=usa"
A binary file was returned

You couldn't be authenticated

{
  "resources": [
    {
      "id": "USA.AK.Allakaket",
      "name": "Allakaket",
      "country": "USA",
      "state": "AK",
      "city": "Allakaket",
      "latitude": 66.56548,
      "longitude": -152.6455
    },
    {
      "id": "USA.AK.Ambler",
      "name": "Ambler",
      "country": "USA",
      "state": "AK",
      "city": "Ambler",
      "latitude": 67.08649,
      "longitude": -157.85141
    },
    ...
    ...
  ]
}

Query Params

country
string
required

the ISO 3166 3 letter country code

 
Suggest Edits

Available Countries

Returns all the countries that you may use to filter monitor results and to upload documents with location information.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://api.crimsonhexagon.com/api/geography/info/countries
curl -X GET "https://api.crimsonhexagon.com/api/geography/info/countries?auth=tokenhere"
A binary file was returned

You couldn't be authenticated

{
  "resources": [
    {
      "id": "ABW",
      "name": "Aruba",
      "country": "ABW",
      "latitude": 12.516935,
      "longitude": -69.9742
    },
    {
      "id": "AFG",
      "name": "Afghanistan",
      "country": "AFG",
      "latitude": 33.836266,
      "longitude": 66.008446
    },
    {
      "id": "AGO",
      "name": "Angola",
      "country": "AGO",
      "latitude": -12.330513,
      "longitude": 17.564337
    },
    ...
    ...
  ]
}
 

This collection of endpoints provide data regarding Crimson Hexagon users.