List Rule Logs

List logs for a particular rule

GET /api/v1/runs/rules/{rule_id}/logs

Error

A valid request URL is required to generate request examples

200

[
  {
    "rule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z",
    "run_name": "<string>",
    "run_type": "<string>",
    "run_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "application_time": "2023-11-07T05:31:56Z",
    "add_to_annotation_queue": {
      "payload": {}
    },
    "add_to_dataset": {
      "payload": {}
    },
    "evaluators": {
      "payload": {}
    },
    "alerts": {
      "payload": {}
    },
    "webhooks": {
      "payload": {}
    },
    "extend_only": {
      "payload": {}
    },
    "thread_id": "<string>"
  }
]

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Path Parameters

rule_id · string<uuid> · required

Query Parameters

limit · integer · default: 150

Required range: 1 <= x <= 1440

offset · integer · default: 0

Required range: x >= 0

start_time · string<date-time> | null

end_time · string<date-time> | null

session_id · string<uuid> | null

Response

200

application/json

Successful Response

rule_id · string<uuid> · required

run_id · string<uuid> · required

start_time · string<date-time> · required

end_time · string<date-time> · required

run_name · string | null

run_type · string | null

run_session_id · string<uuid> | null

application_time · string<date-time> | null

add_to_annotation_queue · RuleLogActionResponse · object

Show child attributes

add_to_dataset · RuleLogActionResponse · object

Show child attributes

evaluators · RuleLogActionResponse · object

Show child attributes

alerts · RuleLogActionResponse · object

Show child attributes

webhooks · RuleLogActionResponse · object

Show child attributes

extend_only · RuleLogActionResponse · object

Show child attributes

thread_id · string | null