API Documentation | Sentimentics

Text API: Text-level analysis

API endpoint:

http://api.sentimentics.com/textSentiment

Parameter: apikey (required parameter)

A private API key is required. If you do not have an API key, get started here.

Parameter: textValue (required parameter)

The text that needs to be analysed. The text needs to be URI encoded.

Parameter: languageValue

At this moment two languages are supported. This parameter is not required because of default value.

Language	Remarks
english	default value
dutch

Parameter: domainType

At this moment one domain is supported. This parameter is not required because of default value.

Domain type	Remarks
general	default value

Parameter: outputType

There are three types of output parameters supported. This parameter is not required because of default value.

Output type	Remarks
xml	default value
json

Response variables

The following response variables are given back after API call.

Response variables	Possibilities	Remarks
success	true false
sentimentValue	value ranging from -1 to +1	-1 most negative possibility 0 is neutral +1 most positive possibility value returns max 2 decimals
sentimentLabel	extremely negative very negative mildly negative neutral mildly positive very positive extremely positive
conflictionValue	value ranging from 0 to 1
conflictionLabel	extremely conflicting very conflicting mildly conflicting no conflicion mildly conflicting very conflicting extremely conflicting
errorMessage		if success == false, error information is generated.

Parameter overview

A summation of the parameter instructions above.

Type of parameter	Possible values	Default value	Remarks
apikey	<APIKEY>		required parameter
textValue	<TEXTVALUE>		required parameter
languageValue	english, dutch	english
domainValue	general	general
outputType	xml, json	xml

http://api.sentimentics.com/textSentiment?apikey=<APIKEY>&textValue=<TEXTVALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

Text API: Keyword-level analysis

API endpoint:

http://api.sentimentics.com/keywordInTextSentiment

Parameter: apikey (required parameter)

A private API key is required. If you do not have an API key, get started here.

Parameter: textValue (required parameter)

The text in which specific keywords are present that need to be analysed. The text needs to be URI encoded.

Parameter: keyword1Value (required parameter)

The keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword2Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword3Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword4Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: languageValue

At this moment two languages are supported. This parameter is not required because of default value.

Language	Remarks
english	default value
dutch

Parameter: domainType

At this moment one domain is supported. This parameter is not required because of default value.

Domain type	Remarks
general	default value

Parameter: outputType

There are three types of output parameters supported. This parameter is not required because of default value.

Output type	Remarks
xml	default value
json

Response variables

The following response variables are given back after API call.

Response variables	Possibilities	Remarks
success	true false
keyword1SentimentValue, keyword2SentimentValue, keyword3SentimentValue, keyword4SentimentValue	value ranging from -1 to +1	-1 most negative possibility 0 is neutral +1 most positive possibility value returns max 2 decimals
keyword1SentimentLabel, keyword2SentimentLabel, keyword3SentimentLabel, keyword4SentimentLabel	extremely negative very negative mildly negative neutral mildly positive very positive extremely positive
keyword1ConflictionValue, keyword2ConflictionValue, keyword3ConflictionValue, keyword4ConflictionValue,	value ranging from 0 to 1
keyword1ConflictionLabel, keyword2ConflictionLabel, keyword3ConflictionLabel, keyword4ConflictionLabel,	extremely conflicting very conflicting mildly conflicting no conflicion mildly conflicting very conflicting extremely conflicting
errorMessage		if success == false, error information is generated.

Parameter overview

A summation of the parameter instructions above.

Type of parameter	Possible values	Default value	Remarks
apikey	<APIKEY>		required parameter
textValue	<TEXTVALUE>		required parameter
keyword1Value	<KEYWORD1VALUE>		required parameter
keyword2Value	<KEYWORD2VALUE>
keyword3Value	<KEYWORD3VALUE>
keyword4Value	<KEYWORD4VALUE>
languageValue	english, dutch	english
domainValue	general	general
outputType	xml, json	xml

http://api.sentimentics.com/keywordInTextSentiment?apikey=<APIKEY>&textValue=<TEXTVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

Text API: Survey analysis

API endpoint:

http://api.sentimentics.com/surveySentiment

Parameter: apikey (required parameter)

A private API key is required. If you do not have an API key, get started here.

Parameter: questionValue (required parameter)

The question in which specific elements are present that need to be analysed. The question needs to be URI encoded.

Parameter: answerValue (required parameter)

The answer in which specific elements are present that need to be analysed. The question needs to be URI encoded.

Parameter: languageValue

At this moment two languages are supported. This parameter is not required because of default value.

Language	Remarks
english	default value
dutch

Parameter: domainType

At this moment one domain is supported. This parameter is not required because of default value.

Domain type	Remarks
general	default value

Parameter: outputType

There are three types of output parameters supported. This parameter is not required because of default value.

Output type	Remarks
xml	default value
json

Response variables

The following response variables are given back after API call.

Response variables	Possibilities	Remarks
success	true false
keyword1SentimentValue, keyword2SentimentValue, keyword3SentimentValue, keyword4SentimentValue	value ranging from -1 to +1	-1 most negative possibility 0 is neutral +1 most positive possibility value returns max 2 decimals
keyword1SentimentLabel, keyword2SentimentLabel, keyword3SentimentLabel, keyword4SentimentLabel	extremely negative very negative mildly negative neutral mildly positive very positive extremely positive
errorMessage		if success == false, error information is generated.

Parameter overview

A summation of the parameter instructions above.

Type of parameter	Possible values	Default value	Remarks
apikey	<APIKEY>		required parameter
questionValue	<TEXTVALUE>		required parameter
answerValue	<TEXTVALUE>		required parameter
languageValue	english, dutch	english
domainValue	general	general
outputType	xml, json	xml

http://api.sentimentics.com/surveySentiment?apikey=<APIKEY>&questionValue=<QUESTIONVALUE>&answerValue=<ANSWERVALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

HTML API: Keyword-level analysis

API endpoint:

http://api.sentimentics.com/keywordInHTMLSentiment

Parameter: apikey (required parameter)

A private API key is required. If you do not have an API key, get started here.

Parameter: HTMLValue (required parameter)

The HTML content in which specific keywords are present that need to be analysed. The HTML content needs to be URI encoded.

Parameter: keyword1Value (required parameter)

The keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword2Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword3Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword4Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: languageValue

At this moment two languages are supported. This parameter is not required because of default value.

Language	Remarks
english	default value
dutch

Parameter: domainType

At this moment one domain is supported. This parameter is not required because of default value.

Domain type	Remarks
general	default value

Parameter: outputType

There are three types of output parameters supported. This parameter is not required because of default value.

Output type	Remarks
xml	default value
json

Response variables

The following response variables are given back after API call.

Response variables	Possibilities	Remarks
success	true false
keyword1SentimentValue, keyword2SentimentValue, keyword3SentimentValue, keyword4SentimentValue	value ranging from -1 to +1	-1 most negative possibility 0 is neutral +1 most positive possibility value returns max 2 decimals
keyword1SentimentLabel, keyword2SentimentLabel, keyword3SentimentLabel, keyword4SentimentLabel	extremely negative very negative mildly negative neutral mildly positive very positive extremely positive
keyword1ConflictionValue, keyword2ConflictionValue, keyword3ConflictionValue, keyword4ConflictionValue,	value ranging from 0 to 1
keyword1ConflictionLabel, keyword2ConflictionLabel, keyword3ConflictionLabel, keyword4ConflictionLabel,	extremely conflicting very conflicting mildly conflicting no conflicion mildly conflicting very conflicting extremely conflicting
errorMessage		if success == false, error information is generated.

Parameter overview

A summation of the parameter instructions above.

Type of parameter	Possible values	Default value	Remarks
apikey	<APIKEY>		required parameter
HTMLValue	<HTMLVALUE>		required parameter
keyword1Value	<KEYWORD1VALUE>		required parameter
keyword2Value	<KEYWORD2VALUE>
keyword3Value	<KEYWORD3VALUE>
keyword4Value	<KEYWORD4VALUE>
languageValue	english, dutch	english
domainValue	general	general
outputType	xml, json	xml

http://api.sentimentics.com/keywordInHTMLSentiment?apikey=<APIKEY>&HTMLValue=<HTMLVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

URL API: Keyword-level analysis

API endpoint:

http://api.sentimentics.com/keywordInURLSentiment

Parameter: apikey (required parameter)

A private API key is required. If you do not have an API key, get started here.

Parameter: URLValue (required parameter)

The URL string in which specific keywords are present that need to be analysed. The URL string needs to be URI encoded.

Parameter: keyword1Value (required parameter)

The keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword2Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword3Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: keyword4Value

If desired, another keyword or keyphrase that need to be analysed. The keyword / keyphrase needs to be URI encoded.

Parameter: languageValue

At this moment two languages are supported. This parameter is not required because of default value.

Language	Remarks
english	default value
dutch

Parameter: domainType

At this moment one domain is supported. This parameter is not required because of default value.

Domain type	Remarks
general	default value

Parameter: outputType

There are three types of output parameters supported. This parameter is not required because of default value.

Output type	Remarks
xml	default value
json

Response variables

The following response variables are given back after API call.

Response variables	Possibilities	Remarks
success	true false
keyword1SentimentValue, keyword2SentimentValue, keyword3SentimentValue, keyword4SentimentValue	value ranging from -1 to +1	-1 most negative possibility 0 is neutral +1 most positive possibility value returns max 2 decimals
keyword1SentimentLabel, keyword2SentimentLabel, keyword3SentimentLabel, keyword4SentimentLabel	extremely negative very negative mildly negative neutral mildly positive very positive extremely positive
keyword1ConflictionValue, keyword2ConflictionValue, keyword3ConflictionValue, keyword4ConflictionValue,	value ranging from 0 to 1
keyword1ConflictionLabel, keyword2ConflictionLabel, keyword3ConflictionLabel, keyword4ConflictionLabel,	extremely conflicting very conflicting mildly conflicting no conflicion mildly conflicting very conflicting extremely conflicting
errorMessage		if success == false, error information is generated.

Parameter overview

A summation of the parameter instructions above.

Type of parameter	Possible values	Default value	Remarks
apikey	<APIKEY>		required parameter
URLValue	<URLVALUE>		required parameter
keyword1Value	<KEYWORD1VALUE>		required parameter
keyword2Value	<KEYWORD2VALUE>
keyword3Value	<KEYWORD3VALUE>
keyword4Value	<KEYWORD4VALUE>
languageValue	english, dutch	english
domainValue	general	general
outputType	xml, json	xml

http://api.sentimentics.com/keywordInURLSentiment?apikey=<APIKEY>&URLValue=<URLVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

Getting started

- Register for an API Key

- Try the product demos

- Download Sentimentics SDKs

- Read the documentation

About the API

Text API: Text-level analysis

API endpoint:

Parameter: apikey (required parameter)

Parameter: textValue (required parameter)

Parameter: languageValue

Parameter: domainType

Parameter: outputType

Response variables

Parameter overview

http://api.sentimentics.com/textSentiment?apikey=<APIKEY>&textValue=<TEXTVALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

Text API: Keyword-level analysis

API endpoint:

Parameter: apikey (required parameter)

Parameter: textValue (required parameter)

Parameter: keyword1Value (required parameter)

Parameter: keyword2Value

Parameter: keyword3Value

Parameter: keyword4Value

Parameter: languageValue

Parameter: domainType

Parameter: outputType

Response variables

Parameter overview

http://api.sentimentics.com/keywordInTextSentiment?apikey=<APIKEY>&textValue=<TEXTVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

Text API: Survey analysis

API endpoint:

Parameter: apikey (required parameter)

Parameter: questionValue (required parameter)

Parameter: answerValue (required parameter)

Parameter: languageValue

Parameter: domainType

Parameter: outputType

Response variables

Parameter overview

http://api.sentimentics.com/surveySentiment?apikey=<APIKEY>&questionValue=<QUESTIONVALUE>&answerValue=<ANSWERVALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

HTML API: Keyword-level analysis

API endpoint:

Parameter: apikey (required parameter)

Parameter: HTMLValue (required parameter)

Parameter: keyword1Value (required parameter)

Parameter: keyword2Value

Parameter: keyword3Value

Parameter: keyword4Value

Parameter: languageValue

Parameter: domainType

Parameter: outputType

Response variables

Parameter overview

http://api.sentimentics.com/keywordInHTMLSentiment?apikey=<APIKEY>&HTMLValue=<HTMLVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

URL API: Keyword-level analysis

API endpoint:

Parameter: apikey (required parameter)

Parameter: URLValue (required parameter)

Parameter: keyword1Value (required parameter)

Parameter: keyword2Value

Parameter: keyword3Value

Parameter: keyword4Value

Parameter: languageValue

Parameter: domainType

Parameter: outputType

Response variables

Parameter overview

http://api.sentimentics.com/keywordInURLSentiment?apikey=<APIKEY>&URLValue=<URLVALUE>&keyword1Value=<KEYWORD1VALUE>&keyword2Value=<KEYWORD2VALUE>&keyword3Value=<KEYWORD3VALUE>&keyword4Value=<KEYWORD4VALUE>&languageValue=<LANGUAGEVALUE>&domainValue=<DOMAINVALUE>&outputType=<OUTPUTTYPE>

FAQ