removeEventsAnalyserWord

A Graze API POST request that removes a single word from the list of priority words or stop words in the Events Analyser configuration. This endpoint removes the word from the list of priority words or stop words depending on the argument you supply. Use updateEventsAnalyserWords to replace an entire list of priority words or stop words, or addEventsAnalyserWord to add a single word to a list of priority words or stop words.

See updateEventsAnalyserConfig for updating the other fields in the Events Analyser configuration.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint removeEventsAnalyserWord takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. See the authenticate endpoint for more information.

type

String

Yes

Determines whether the endpoint removes the word from the list of priority words or stop words. Set to priority_word to remove the word from the list of priority words. Set to stop_word to remove the word from the list of stop words.

Response

Endpoint removeEventsAnalyserWord returns the following response:

Examples

The following examples demonstrate typical use of endpoint removeEventsAnalyserWord:

Request examples

Example cURL request to remove the word 'fail' from the list of priority words in the Events Analyser configuration:

curl -POST -u graze:graze -k -v "https://localhost/graze/v1/removeEventsAnalyserWord" \
--data-urlencode 'type=priority_word' \
--data-urlencode 'word="fail"'

Example cURL request to remove the word 'then' from the list of stop words in the Events Analyser configuration:

curl -POST -u graze:graze -k -v "https://localhost/graze/v1/removeEventsAnalyserWord" \
--data-urlencode 'type=stop_word' \
--data-urlencode 'word="then"'

Response example