Skip to main content
POST
/
api
/
v1
/
rules
/
evaluate
EvaluateRules
curl --request POST \
  --url https://api.siftstack.com/api/v1/rules/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ruleIds": [
    "<string>"
  ],
  "annotationOptions": {
    "tagIds": [
      "<string>"
    ]
  },
  "runId": "<string>",
  "timeRange": {
    "startTime": "2023-11-07T05:31:56Z",
    "endTime": "2023-11-07T05:31:56Z"
  },
  "dryRun": true
}
'
{
  "createdAnnotationCount": 123,
  "dryRunAnnotations": [
    {
      "startTime": "2023-11-07T05:31:56Z",
      "endTime": "2023-11-07T05:31:56Z",
      "conditionId": "<string>",
      "name": "<string>",
      "conditionVersionId": "<string>"
    }
  ],
  "jobId": "<string>",
  "reportId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Deprecated - use RuleEvaluationService instead.

Deprecated - use RuleEvaluationService instead.

​
ruleIds
string[]
required
​
annotationOptions
object
​
runId
string
​
timeRange
object
​
dryRun
boolean

Response

A successful response.

Deprecated - use RuleEvaluationService instead.

​
createdAnnotationCount
integer<int32>
​
dryRunAnnotations
If dry_run is true, this will be populated with the annotations that would be created · object[]
​
jobId
string

job_id and report_id will be set if the job has an extended run time and is being processed asynchronously.

​
reportId
string