Rule Runs

Re-evaluate a rule over a period

Runs the rule again across a period you name, and returns the run so you can follow it.

You do not need this after writing an event, applying a batch correction or setting a data point value. Each of those already re-evaluates the records it touched. Reach for it when a rule was fixed after the fact, or when data changed underneath a period that has already been evaluated.

Both bounds are required. The dashboard treats a missing bound as unbounded, but a script that omitted one would silently widen the run to the project’s whole history, so here an absent bound is refused.

A run that completes without changing a verdict is a normal outcome, not a failure.

POST

projects

{project_id}

rules

{rule_id}

runs

Re-evaluate a rule over a period

curl --request POST \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "range_start": "2023-11-07T05:31:56Z",
  "range_end": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs"

payload = {
    "range_start": "2023-11-07T05:31:56Z",
    "range_end": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({range_start: '2023-11-07T05:31:56Z', range_end: '2023-11-07T05:31:56Z'})
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'range_start' => '2023-11-07T05:31:56Z',
    'range_end' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs"

	payload := strings.NewReader("{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "rrun_AbCd1234567890Ef",
  "rule_id": "rule_AbCd1234567890Ef",
  "state": "running",
  "phase": "evaluating",
  "trigger": "on_demand",
  "range_start": "2026-07-01T00:00:00Z",
  "range_end": "2026-07-31T23:59:59Z",
  "started_at": "2026-08-28T14:22:06Z",
  "finished_at": null,
  "last_evaluated_at": "2026-08-28T14:22:31Z",
  "targets_total": 1450,
  "targets_processed": 600,
  "passed_count": 580,
  "alerted_count": 20,
  "results_changed_count": 12,
  "newly_alerted_count": 9,
  "newly_cleared_count": 3,
  "reversible": false,
  "non_reversible_reason": "A run cannot be reversed while it is still evaluating",
  "reversal_summary": null,
  "triggered_by": "Sam Okonkwo",
  "error_message": null
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

Project friendly ID (e.g. prj_AbCd1234567890Ef).

rule_id

string

required

Rule friendly ID.

Body

application/json

range_start

string<date-time>

required

ISO-8601. Anything unreadable is refused rather than treated as absent.

range_end

string<date-time>

required

Response

201

string

Run friendly ID (e.g. rrun_AbCd1234567890Ef).

rule_id

string

state

enum<string>

Available options:

running,

completed,

failed,

superseded,

reversing,

reversed,

reversal_failed

phase

enum<string> | null

Where a running run has got to. Null once it is no longer running.

Available options:

queued,

preparing,

evaluating

trigger

enum<string>

What started the run. A run you create here is on_demand.

Available options:

authoring,

ingestion,

schedule_sweep,

on_demand

range_start

string<date-time>

range_end

string<date-time>

started_at

string<date-time> | null

finished_at

string<date-time> | null

last_evaluated_at

string<date-time> | null

targets_total

integer

targets_processed

integer

passed_count

integer

alerted_count

integer

results_changed_count

integer

How many verdicts this run actually changed.

newly_alerted_count

integer

newly_cleared_count

integer

reversible

boolean

Whether this run can still be taken back.

non_reversible_reason

string | null

Why it cannot, when reversible is false.

reversal_summary

object | null

What a reversal did, once one has run, including the rows it declined to touch and why.

triggered_by

string | null

The name of the person who started it. Null for a run started by an account-scoped token, which has no person behind it.

error_message

string | null

Re-evaluate a rule over a period

curl --request POST \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "range_start": "2023-11-07T05:31:56Z",
  "range_end": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs"

payload = {
    "range_start": "2023-11-07T05:31:56Z",
    "range_end": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({range_start: '2023-11-07T05:31:56Z', range_end: '2023-11-07T05:31:56Z'})
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'range_start' => '2023-11-07T05:31:56Z',
    'range_end' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs"

	payload := strings.NewReader("{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}/runs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"range_start\": \"2023-11-07T05:31:56Z\",\n  \"range_end\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "rrun_AbCd1234567890Ef",
  "rule_id": "rule_AbCd1234567890Ef",
  "state": "running",
  "phase": "evaluating",
  "trigger": "on_demand",
  "range_start": "2026-07-01T00:00:00Z",
  "range_end": "2026-07-31T23:59:59Z",
  "started_at": "2026-08-28T14:22:06Z",
  "finished_at": null,
  "last_evaluated_at": "2026-08-28T14:22:31Z",
  "targets_total": 1450,
  "targets_processed": 600,
  "passed_count": 580,
  "alerted_count": 20,
  "results_changed_count": 12,
  "newly_alerted_count": 9,
  "newly_cleared_count": 3,
  "reversible": false,
  "non_reversible_reason": "A run cannot be reversed while it is still evaluating",
  "reversal_summary": null,
  "triggered_by": "Sam Okonkwo",
  "error_message": null
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Re-evaluate a rule over a period

Authorizations

Path Parameters

Body

Response