Crimson Hexagon API

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

Post Filtering

Filter posts in the /posts endpoint

Some endpoints support filtering directly within the query without creating a filter through the UI. For these endpoints, you may use the following rules.

URL Encoded

Due to the complexity of some queries (whitespace and unique characters) ensure that the URL is properly encoded when making requests or the request may fail.

For endpoints that support filtering, you can add pipe delimited values as a query parameter. For example:

&filter=site:google.com|keywords:(android OR ios)|geolocation:USA.NY.New York

Supported filters include:

Key
Example Value
Description

site

google.com

keywords

(iPhone OR Android AND "new phone")

geolocation

USA.NY.New York

One of the geolocations found via the /geography/all endpoint.

category

123456789

Numerical identifier representing the category you want to filter by (emotion, sentiment and opinion monitor categories).

Category IDs are available via the /monitor/detail endpoint.

Post Filtering

Filter posts in the /posts endpoint

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.