Retrieve a datapoint

GET

projects

{project_id}

events

{event_id}

data_points

{data_point_id}

Retrieve a datapoint

curl --request GET \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_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}/events/{event_id}/data_points/{data_point_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "in_kiIuaGIUqRxWUmTY",
  "slug": "total-ash-delivered-wet-us-ton",
  "data_point_type": "Total Ash Delivered (wet mass) U.S. ton",
  "value": 290.6,
  "unit": "U.S. ton",
  "status": "complete",
  "substituted": false,
  "imputed": false,
  "raw_value": null,
  "substitution": null,
  "rule_results": [
    {
      "id": "dpres_8XF1QtGs79oX9A6k",
      "status": "dismissed",
      "entered_value": "290.6",
      "rule_id": "rule_Qb3k9TzdL0pWnXyz",
      "rule_version": 2,
      "rule_name": "Ash mass within expected range",
      "data_point_id": "in_kiIuaGIUqRxWUmTY",
      "data_point_slug": "total-ash-delivered-wet-us-ton",
      "dismissed_at": "2024-06-05T09:10:00.000Z",
      "dismissed_by": "Sam Okonkwo",
      "dismissal_reason": "Verified against weighbridge ticket",
      "evaluated_at": "2024-06-05T09:10:00.000Z"
    }
  ]
}

{
  "errors": [
    {
      "message": "Evidence not found."
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

event_id

string

required

Unique ID of event in the evt_XXXX syntax. For example: evt_DLnYvzbjSujNAvXE

data_point_id

string

required

Unique ID of datapoint in the in_XXXX syntax. For example: in_kiIuaGIUqRxWUmTY

Response

200

string

Example:

"in_kiIuaGIUqRxWUmTY"

slug

string

Example:

"total-ash-delivered-wet-us-ton"

data_point_type

string

Example:

"Total Ash Delivered (wet mass) U.S. ton"

value

number

default:0

Example:

290.6

unit

string

Example:

"U.S. ton"

status

string

Example:

"complete"

substituted

boolean

A value existed on this data point and a correction replaced it.

imputed

boolean

No value ever existed on this data point and a correction supplied one.

raw_value

The value as captured, before any correction. Null on an imputed data point.

substitution

object | null

The most recent correction standing on a data point, or null when none does. The full history is on the corrections endpoint. This summary and the substituted, imputed and raw_value fields beside it report corrections where they are enabled for the account.

Show child attributes

rule_results

object[]

Rule alerts on this data point, failing or dismissed results only, latest version per rule. Each entry matches the data point rule result shape returned by the bulk dismiss endpoint. The same serializer is reused on the data point list, create, and update responses, so this field is present there too (and on the parent event's data points).

Retrieve a datapoint

curl --request GET \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id} \
  --header 'Authorization: <api-key>'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_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}/events/{event_id}/data_points/{data_point_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/projects/{project_id}/events/{event_id}/data_points/{data_point_id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "id": "in_kiIuaGIUqRxWUmTY",
  "slug": "total-ash-delivered-wet-us-ton",
  "data_point_type": "Total Ash Delivered (wet mass) U.S. ton",
  "value": 290.6,
  "unit": "U.S. ton",
  "status": "complete",
  "substituted": false,
  "imputed": false,
  "raw_value": null,
  "substitution": null,
  "rule_results": [
    {
      "id": "dpres_8XF1QtGs79oX9A6k",
      "status": "dismissed",
      "entered_value": "290.6",
      "rule_id": "rule_Qb3k9TzdL0pWnXyz",
      "rule_version": 2,
      "rule_name": "Ash mass within expected range",
      "data_point_id": "in_kiIuaGIUqRxWUmTY",
      "data_point_slug": "total-ash-delivered-wet-us-ton",
      "dismissed_at": "2024-06-05T09:10:00.000Z",
      "dismissed_by": "Sam Okonkwo",
      "dismissal_reason": "Verified against weighbridge ticket",
      "evaluated_at": "2024-06-05T09:10:00.000Z"
    }
  ]
}

{
  "errors": [
    {
      "message": "Evidence not found."
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Response