Update a rule

PATCH

projects

{project_id}

rules

{rule_id}

Update a rule

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule": {
    "method_chain": [
      {
        "method": "trailing_average",
        "params": {
          "window": {
            "kind": "rolling",
            "value": 14,
            "unit": "day"
          }
        }
      },
      {
        "method": "forward_fill"
      }
    ]
  }
}
'

import requests

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

payload = { "rule": { "method_chain": [{
                "method": "trailing_average",
                "params": { "window": {
                        "kind": "rolling",
                        "value": 14,
                        "unit": "day"
                    } }
            }, { "method": "forward_fill" }] } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rule: {
      method_chain: [
        {
          method: 'trailing_average',
          params: {window: {kind: 'rolling', value: 14, unit: 'day'}}
        },
        {method: 'forward_fill'}
      ]
    }
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'rule' => [
        'method_chain' => [
                [
                                'method' => 'trailing_average',
                                'params' => [
                                                                'window' => [
                                                                                                                                'kind' => 'rolling',
                                                                                                                                'value' => 14,
                                                                                                                                'unit' => 'day'
                                                                ]
                                ]
                ],
                [
                                'method' => 'forward_fill'
                ]
        ]
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}"

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

{
  "id": "rule_Qb3k9TzdL0pWnXyz",
  "name": "<string>",
  "pending_count": 123,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/settings/data-rules/rule_Qb3k9TzdL0pWnXyz",
  "rule_type": "alert",
  "action": "alert",
  "method_chain": [
    {
      "method": "constant",
      "params": {
        "value": 123,
        "slug": "<string>",
        "percentile": 50,
        "window": {
          "kind": "rolling",
          "value": 123,
          "unit": "<string>",
          "offset": 0,
          "extent": "to_date"
        }
      }
    }
  ],
  "window_member_scope": "none",
  "requires_approval": false,
  "evaluation": "automatic",
  "target_type": "data_point",
  "status": "active",
  "enabled": true,
  "rule_text": "{{data-point.ambient-temperature-c}} < 0",
  "subject_slugs": [
    "<string>"
  ],
  "alert_message": "<string>",
  "version": 123,
  "effective_from": "2023-12-25",
  "effective_to": "2023-12-25",
  "model_id": "<string>",
  "model_name": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "backfill_enqueued": true
}

{
  "errors": [
    {
      "message": "Subject slugs must name exactly one data point to correct (got 2)",
      "field": "subject_slugs",
      "code": "single_subject_required",
      "slugs": [
        "ambient-temperature-c",
        "ambient-humidity-pct"
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

rule_id

string

required

Body

application/json

rule

object

required

The rule body on a create or update. On an update, send only the fields you are changing.

Show child attributes

Response

200

A data rule on a project. The rule's identity is stable across edits; the condition lives on its latest version.

string

Rule friendly ID.

Example:

"rule_Qb3k9TzdL0pWnXyz"

name

string

pending_count

integer

Proposed corrections waiting on a decision across the rule's active versions.

ui_url

string

Link that opens this rule in the Mangrove app.

Example:

"https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/settings/data-rules/rule_Qb3k9TzdL0pWnXyz"

rule_type

enum<string>

Derived from action. Read-only.

Available options:

alert,

substitution

action

enum<string>

alert flags the matching record and changes nothing. substitute replaces the matching value with one derived from method_chain. Only data point rules may substitute.

Available options:

alert,

substitute

method_chain

object[]

Ordered substitution candidates. The first method that resolves wins. Empty on alert rules.

Show child attributes

window_member_scope

enum<string>

default:none

Which data points in a fired window the rule acts on. none acts on the data point that made the condition true. all extends the action to every data point in the window: an alert rule flags them, a substitute rule corrects them. repeats acts on the repeated values in a stuck-sensor run and leaves the value that opened the run as measured. Anything other than none needs a windowed aggregate in rule_text.

Available options:

none,

all,

repeats

requires_approval

boolean

default:false

Whether this rule's corrections wait for a person to approve them instead of being written. Substitute rules only.

evaluation

enum<string>

automatic rules are evaluated as data arrives, and over history when the rule is saved. on_demand rules run only over a period started with Re-evaluate a rule over a period. An on_demand model rule is not evaluated when its model run finishes.

Available options:

automatic,

on_demand

target_type

enum<string>

data_point evaluates event data as it arrives. model evaluates model outputs after a batch calculation.

Available options:

data_point,

model

status

enum<string>

Available options:

active

enabled

boolean

rule_text

string

The condition, in the rule expression language.

Example:

"{{data-point.ambient-temperature-c}} < 0"

subject_slugs

string[]

On an alert rule, narrows which of the values the condition reads may be flagged. On a substitute rule, names the single value the rule corrects.

alert_message

string | null

Shown on the records this rule flags. Required on an alert rule. Optional on a substitute rule, where it covers the records whose method chain resolved nothing, and Mangrove supplies a default.

version

integer

effective_from

string<date> | null

effective_to

string<date> | null

model_id

string | null

Model rules only.

model_name

string | null

created_by

string

created_at

string<date-time>

updated_at

string<date-time>

backfill_enqueued

boolean

Whether this update started a re-evaluation. An on_demand rule starts none, so it reads false there even when the update minted a version.

Update a rule

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "rule": {
    "method_chain": [
      {
        "method": "trailing_average",
        "params": {
          "window": {
            "kind": "rolling",
            "value": 14,
            "unit": "day"
          }
        }
      },
      {
        "method": "forward_fill"
      }
    ]
  }
}
'

import requests

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

payload = { "rule": { "method_chain": [{
                "method": "trailing_average",
                "params": { "window": {
                        "kind": "rolling",
                        "value": 14,
                        "unit": "day"
                    } }
            }, { "method": "forward_fill" }] } }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    rule: {
      method_chain: [
        {
          method: 'trailing_average',
          params: {window: {kind: 'rolling', value: 14, unit: 'day'}}
        },
        {method: 'forward_fill'}
      ]
    }
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}', 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}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'rule' => [
        'method_chain' => [
                [
                                'method' => 'trailing_average',
                                'params' => [
                                                                'window' => [
                                                                                                                                'kind' => 'rolling',
                                                                                                                                'value' => 14,
                                                                                                                                'unit' => 'day'
                                                                ]
                                ]
                ],
                [
                                'method' => 'forward_fill'
                ]
        ]
    ]
  ]),
  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}"

	payload := strings.NewReader("{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/rules/{rule_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"rule\": {\n    \"method_chain\": [\n      {\n        \"method\": \"trailing_average\",\n        \"params\": {\n          \"window\": {\n            \"kind\": \"rolling\",\n            \"value\": 14,\n            \"unit\": \"day\"\n          }\n        }\n      },\n      {\n        \"method\": \"forward_fill\"\n      }\n    ]\n  }\n}"

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

{
  "id": "rule_Qb3k9TzdL0pWnXyz",
  "name": "<string>",
  "pending_count": 123,
  "ui_url": "https://app.gomangrove.com/nexus/prj_AbCd1234567890Ef/settings/data-rules/rule_Qb3k9TzdL0pWnXyz",
  "rule_type": "alert",
  "action": "alert",
  "method_chain": [
    {
      "method": "constant",
      "params": {
        "value": 123,
        "slug": "<string>",
        "percentile": 50,
        "window": {
          "kind": "rolling",
          "value": 123,
          "unit": "<string>",
          "offset": 0,
          "extent": "to_date"
        }
      }
    }
  ],
  "window_member_scope": "none",
  "requires_approval": false,
  "evaluation": "automatic",
  "target_type": "data_point",
  "status": "active",
  "enabled": true,
  "rule_text": "{{data-point.ambient-temperature-c}} < 0",
  "subject_slugs": [
    "<string>"
  ],
  "alert_message": "<string>",
  "version": 123,
  "effective_from": "2023-12-25",
  "effective_to": "2023-12-25",
  "model_id": "<string>",
  "model_name": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "backfill_enqueued": true
}

{
  "errors": [
    {
      "message": "Subject slugs must name exactly one data point to correct (got 2)",
      "field": "subject_slugs",
      "code": "single_subject_required",
      "slugs": [
        "ambient-temperature-c",
        "ambient-humidity-pct"
      ]
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Body

Response