getSimilarSituationIds
A Graze API GET request that returns a list of IDs of similar Situations, for a specified Situation ID and a limit.
Back to Graze API EndPoint Reference.
Request arguments
Endpoint getSimilarSituationIds
takes the following request arguments:
Name |
Type |
Required |
Description |
---|---|---|---|
|
String |
Yes |
A valid |
|
Number |
Yes |
ID of the Situation that you want to retrieve similar Situations for. |
|
Number |
No |
Maximum number of Situation IDs to return. Defaults to 100. |
Response
Endpoint getSimilarSituationIds
returns the following response:
Successful requests return a JSON object containing the following:
Name |
Type |
Description |
---|---|---|
|
Array of Numbers |
List of IDs of similar Situations. |
|
Number |
ID of the Situation that you requested to retrieve similar Situations for. |
Examples
The following examples demonstrate typical use of endpoint getSimilarSituationIds
:
Request example
Example cURL request to return the first 10 Situation IDs that are similar to Situation ID 1043:
curl -G -u graze:graze -k -v "https://localhost/graze/v1/getSimilarSituationIds" \ --data-urlencode "sitn_id=1043" \ --data-urlencode "limit=10"
Response example
Example response returning the Situation IDs that are similar to Situation ID 1043:
{ "similarity_ids": [ 43,156,177,221,576,1026,1327 ], "sig_id": 1043 }