Do you have any questions? Write us an email or ask us through the feedback section.
This API is currently in a beta version! Send us some feedback and help us improve.

Response

The output contains information about the status of the request. Ultimately, it summarizes the reputational analysis of the text across three distinct axes. In the first instance, the entities (i.e., companies) detected in the text are obtained. Second, the reputational dimensions (categories) affecting each of the entities are output, each with an associated polarity. Finally, the global polarity for each entity is included, which in turn can be used as an indication as to whether the given text will likely have a positive, negative, neutral or no effect on the reputation of each of the entities detected in the text. Any phrases that have been relevant in the decision-making process are also output.

Sample response:

Endesa is building the largest photovoltaic project for self-consumption in the Balearic Islands

{
"status":{
"code":
0
"msg":
"OK"
"credits":
1
}
"entity_list":[
0:{
"id":
"60f9a019a5"
"form":
"Endesa"
"type":
"Top>Organization>Company>UtilitiesCompany"
"polarity":
"P+"
"category_list":[
...
]
}
]
}

Response object:

NameDescription
statusDescribes the request outcome in terms of success or failure.
status.codeNumerical value of result code. Refer to the error code catalog.
status.msgHuman-readable error code, if any, orOK.
status.creditsCredits consumed by the request.
status.remaining_creditsCredits left to reach the usage limit.
time

Time taken for the API to perform de request.

deep_time

Time taken for the engine to perform the analysis.

entity_list

List of the entities identified in the text. In the case that no entity is detected in the text and if no input focus has been specified, a special entity _DEFAULT_ will be obtained in order to obtain general information from the whole text.

entity_list[].id

Id of the entity. This ID will correspond to its senseID in the resources. If the entity has been detected in the analysis, the ID will be specifically created for that analysis and will begin by two underscores.

entity_list[].form

Main form of the entity.

entity_list[].type

Ontology type of the entity. Refer to Organizations according to MeaningCloud's ontology.

entity_list[].polarity

Global polarity of the entity. Possible values:

  • P+: strong positive
  • P: positive
  • NEU: neutral
  • N: negative
  • N+: strong negative
  • NONE: without polarity

entity_list[].category_list

List of reputational categories in which the entity is classified.

entity_list[].category_list[].code

Category code.

entity_list[].category_list[].label

Category description.

entity_list[].category_list[].polarity

Polarity associated to the category.

entity_list[].category_list[].abs_relevance

Absolute relevance value of the category.

entity_list[].category_list[].relat_relevance

Relative relevance value of the category, a number in the 0-100% range, and computed with respect to the top ranked result.

entity_list[].category_list[].sentence_list

List of sentences in which the text is divided.

entity_list[].category_list[].sentence_list[].text

Sentence text.

entity_list[].category_list[].sentence_list[].inip

Position of the first character of the sentence (zero indexed).

entity_list[].category_list[].sentence_list[].endp

Position of the last character of the sentence (zero indexed).