Skip to main content

getEventsAnalyserWords

A Graze API GET request that returns the list of priority words or stop words used by the Events Analyser. This endpoint returns the stop words or priority words for the default partition, depending on the argument you supply.

See getEventsAnalyserConfig to return the main Events Analyser configuration.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint getEventsAnalyserWords takes the following request arguments:

Name

Type

Required

Description

auth_token

String

Yes

A valid auth_token returned from the authenticate request. Alternatively, basic authenticate headers can be used in place of this parameter. See the authenticate endpoint for more information and usage examples.

type

String

Yes

Determines whether the endpoint returns a list of stop words or priority words. Set to priority_word for the list of priority words. Set to stop_word for the list of stop words.

Response

Endpoint getEventsAnalyserWords returns the following response:

Successful requests return the following:

Type

Description

JSON Array

List of priority words or stop words, depending on the request argument type.

Examples

The following examples demonstrate typical use of endpoint getEventsAnalyserWords:

Priority words example

Request example

Example cURL request to return the list of priority words:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getEventsAnalyserWords" --data-urlencode 'type=priority_word'

Stop words example

Request example

Example cURL request to return the list of stop words:

curl -G -u graze:graze -k -v "https://localhost/graze/v1/getEventsAnalyserWords" \ --data-urlencode 'type=stop_word'

Response example

Example response returning the list of stop words:

[
    "%",
    ":",
    "=",
    ".",
    "|",
    "-",
    "~",
    "&",
    "a",
    "able",
    "about",
    "across",
    "after",
    "all",
    "almost",
    "also",
    "am",
    "among",
    "an",
    "and",
    "any",
    "are",
    "as",
    "at",
    "be",
    "because",
    "been",
    "but",
    "by",
    "can",
    "cannot",
    "could",
    "dear",
    "did",
    "do",
    "does",
    "either",
    "else",
    "ever",
    "every",
    "for",
    "from",
    "get",
    "got",
    "had",
    "has",
    "have",
    "he",
    "her",
    "hers",
    "him",
    "his",
    "how",
    "however",
    "i",
    "if",
    "in",
    "into",
    "is",
    "it",
    "its",
    "just",
    "least",
    "let",
    "like",
    "likely",
    "may",
    "me", 
    "might",
    "most",
    "must",
    "my",
    "neither",
    "no",
    "nor",
    "not",
    "of",
    "off",
    "often",
    "on",
    "only",
    "or",
    "other",
    "our",
    "own",
    "rather",
    "said",
    "say",
    "says",
    "she",
    "should",
    "since",
    "so",
    "some",
    "than",
    "that",
    "the",
    "their",
    "them",
    "then",
    "there",
    "these",
    "they",
    "this",
    "tis",
    "to",
    "too",
    "twas",
    "us",
    "wants",
    "was",
    "we",
    "were",
    "what",
    "when",
    "where",
    "which",
    "while",
    "who",
    "whom",
    "why",
    "will",
    "with",
    "would",
    "yet",
    "you",
    "your"
]
In this section: