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.

📘

Additional Parameters

There are three additional parameters which can be used to filter results of the Analysis Request which are included in the example code, but not in the parameter list due to the format not currently being supported in the test call functionality on this page.

Languages
An array of languages can be provided to either include or exclude from the analysis. Please note that specifying to include all languages will exclude all posts will unassigned language; likewise excluding all languages will include only posts with unassigned language.

"languages": {
"type": "include",
"values": [
"EN"
]
}

Locations
An array of locations can be provided to either include or exclude from the analysis. Please note that specifying to include all locations will exclude all posts will unassigned location; likewise excluding all locations will include only posts with unassigned location.

"locations": {
"type": "exclude",
"values": [
"JPN"
]
}

Gender
An array of genders can be provided to either include or exclude from the analysis. Please note that specifying to include both M (male) and F (female) will exclude all authors with an unassigned gender; likewise excluding both M and F will include only authors with an unassigned gender.

"gender": {
"type": "include",
"values": ["M"]
}

📘

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:

    "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.

Language
Authentication
Query
Click Try It! to start a request and see the response here!