Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Rule Results

List rule results

get

Return paginated rule results, optionally filtering by date and comparison field.

Query parameters
sincestring · date-timeOptional

Filter results since this date (ISO 8601)

fromstring · enumOptional

Field to compare 'since' against ('date' or 'updated_at')

Possible values:
Responses
200

Rule results response

application/json
get/api/rule_results
GET /api/rule_results HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": 701,
      "implementation_id": 10,
      "inserted_at": "2026-03-30T06:37:42Z",
      "result": 98,
      "updated_at": "2026-03-30T06:37:42Z"
    }
  ]
}

Upload rule results

post

Upload a CSV file with rule result records and process them into the system.

Body
rule_resultsstring · binaryRequired

CSV file with rule results (columns: implementation_key, date, result, records, errors, m:param1, ...)

Responses
200

Rule result upload successful

No content
post/api/rule_results
POST /api/rule_results HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 31

{
  "rule_results": "file_content"
}
No content

Search rule results

post

Perform a search for rule results with optional pagination and return the matching results.

Query parameters
pageintegerOptional

Page number

Default: 0
sizeinteger · min: 1Optional

Page size

Default: 20
Body
pageintegerOptional

Page number

Default: 0
sizeinteger · min: 1Optional

Page size

Default: 20
Responses
200

Rule result search response

application/json
post/api/rule_results/search
POST /api/rule_results/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "filters": {
    "status": [
      "failed"
    ]
  },
  "page": 0,
  "size": 50
}
{
  "data": [
    {
      "id": 701,
      "implementation_id": 10,
      "inserted_at": "2026-03-30T06:37:42Z",
      "result": 98,
      "updated_at": "2026-03-30T06:37:42Z"
    }
  ]
}

Get a rule result

get

Retrieve a specific rule result by its ID if the current user can view it.

Path parameters
idintegerRequired

Rule result ID

Responses
200

Rule result response

application/json
get/api/rule_results/{id}
GET /api/rule_results/{id} HTTP/1.1
Accept: */*

{
  "data": {
    "id": 701,
    "implementation_id": 10,
    "inserted_at": "2026-03-30T06:37:42Z",
    "result": 98,
    "updated_at": "2026-03-30T06:37:42Z"
  }
}

Delete a rule result

delete

Delete the specified rule result record after authorization.

Path parameters
idintegerRequired

Rule result ID

Responses
204

Rule result deleted

No content
delete/api/rule_results/{id}
DELETE /api/rule_results/{id} HTTP/1.1
Accept: */*

No content

Last updated