Skip to main content

setGlobalEntropyThreshold

A Graze API POST request that sets the global default entropy threshold or a manager-specific entropy threshold, either as a value or as a percentage.

Back to Graze API EndPoint Reference.

Request arguments

Endpoint setGlobalEntropyThreshold 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

Either:

  • entropy_value: Indicates that you want to set a global entropy threshold value.

  • percentage_reduction: Indicates that you want to set a percentage that you want to reduce the current global entropy threshold by.

value

Number

Yes

Entropy threshold. A number between 0.0 and 1.0 for both an entropy value and a percentage.

name

String

No

Name of the entropy threshold.

filter

String

No

An SQL-like filter of the manager.

See Filter Search Data for more information on creating SQL-like filters.

Response

Endpoint setGlobalEntropyThreshold returns the following response:

Examples

The following examples demonstrate typical use of endpoint setGlobalEntropyThreshold:

Request example

Example cURL request to set an entropy threshold as a percentage of 50% for manager "manager1":

curl -X POST -u graze:graze -k -v  "https://localhost/graze/v1/setGlobalEntropyThreshold" -H "Content-Type: application/json; charset=UTF-8" -d '{ \
"type" : "percentage_reduction", \
"value" : 0.5, \
"name" : "manager1", \
"filter" : "manager='manager1'" \
}'

Response example