List all events on a project

GET

projects

{project_id}

events

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

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

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/events', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "evt_mNoP3456qRsT7890",
      "slug": "biochar-delivery",
      "event_type": "Biochar Delivery",
      "tracking_id": "MG1003",
      "start_time": "2024-06-04T00:00:00.000Z",
      "end_time": "2024-06-04T23:59:59.000Z",
      "data_points": [
        {
          "id": "in_mNoP3456qRsT7890",
          "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"
        },
        {
          "id": "in_uVwX1234yZaB5678",
          "slug": "distance-biochar-transported",
          "data_point_type": "Biochar distance transported",
          "value": 15.3,
          "unit": "mile",
          "status": "complete"
        },
        {
          "id": "in_cDeF9012gHiJ3456",
          "slug": "biochar-end-use",
          "data_point_type": "Biochar end use",
          "value": "soil amendment",
          "unit": null,
          "status": "complete"
        }
      ],
      "locations": [
        {
          "id": "loc_mNoP3456qRsT7890",
          "lat": "40.4773493",
          "long": "-124.1226179",
          "name": "Production Facility",
          "address": {
            "name": "Production Facility",
            "street_address_1": null,
            "street_address_2": null,
            "city": null,
            "state": null,
            "postal_code": null,
            "country": "CA"
          }
        },
        {
          "id": "loc_mNoP3456qRsT7890",
          "lat": "41.2733453",
          "long": "-122.2246676",
          "name": "Customer Location",
          "address": {
            "name": "Customer Location",
            "street_address_1": null,
            "street_address_2": null,
            "city": null,
            "state": null,
            "postal_code": null,
            "country": "CA"
          }
        }
      ],
      "evidences": [
        {
          "id": 1,
          "url": "XXXXXXX",
          "evidence_type": "file",
          "name": "Receipt.pdf"
        }
      ]
    }
  ],
  "info": {
    "items": 10,
    "page_size": 10,
    "total_items": 120105,
    "current_page": 1,
    "next_page": 2,
    "previous_page": null,
    "total_pages": 12011,
    "sort": [
      {
        "field": "start_time",
        "direction": "desc"
      }
    ],
    "filter": [
      {
        "field": "status",
        "operator": "eq",
        "value": "complete"
      }
    ]
  }
}

{
  "status": "error",
  "statusCode": 404,
  "errors": [
    {
      "message": "record not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

The project's friendly ID (e.g. prj_aBcD1234eFgH5678).

Query Parameters

page

integer<int32>

default:1

Page number to return.

page_size

integer<int32>

default:20

Number of events to return per page.

Required range: x <= 200

sort

string

Comma-separated list of fields to sort by. Prefix with - for descending. Available fields: id, start_time, end_time, created_at, updated_at, status, tracking_id, friendly_id. Unknown fields are ignored. Defaults to start_time ascending; ties use id ascending. Offset pagination is stable only while matching data remains unchanged.

Example:

"-start_time,created_at"

filter[status][eq]

enum<string>

Available options:

complete,

incomplete,

pending_review,

anomalous

filter[tracking_id][eq]

string

filter[friendly_id][eq]

string

filter[start_time][geq]

string<date-time>

Filter events starting on or after this date

filter[start_time][leq]

string<date-time>

Filter events starting on or before this date

filter[end_time][geq]

string<date-time>

Filter events ending on or after this date

filter[end_time][leq]

string<date-time>

Filter events ending on or before this date

filter[created_at][geq]

string<date-time>

Filter events created on or after this date

filter[created_at][leq]

string<date-time>

Filter events created on or before this date

filter[updated_at][geq]

string<date-time>

Filter events updated on or after this date

filter[updated_at][leq]

string<date-time>

Filter events updated on or before this date

filter[event_type_id][eq]

string

Filter events by event type friendly ID (e.g. et_AAAAAAAAAAAAAAAA), as returned by GET /projects/{project_id}/event_types. An event type outside the project returns an empty page. Only the eq comparator is supported; any other comparator returns 400.

filter[slug][eq]

string

Filter events by event type slug (e.g. biochar-delivery), the same slug rendered on each event in the response; events have no slug of their own. Equivalent to filter[event_type_id][eq]; an unknown slug returns an empty page. Only the eq comparator is supported; any other comparator returns 400.

filter[location_id][eq]

string

Filter events by location friendly ID (e.g. loc_AAAAAAAAAAAAAAAA). Matches events linked to that location. A location outside the project returns an empty page. Only the eq comparator is supported; any other comparator returns 400. Not supported with response_mode=summary_with_export, which returns 400.

filter[feedstock_id][eq]

string

Filter events by feedstock friendly ID (e.g. fds_AAAAAAAAAAAAAAAA). Only the eq comparator is supported; any other comparator returns 400.

filter[asset_id][eq]

string

Filter events by asset friendly ID (e.g. asset_AAAAAAAAAAAAAAAA). Returns only events at that asset, which must belong to the project directly or through one of its locations. Only the eq comparator is supported; any other comparator returns 400.

filter[source_category][eq]

enum<string>

Filter events by source category (e.g. manual, api, pipeline, scheduled_fetch)

Available options:

manual,

supplier,

etl,

pipeline,

api,

scheduled_fetch,

calculated

response_mode

enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. summary_with_export returns the summary and queues an export of every matching record.

Available options:

default,

summary,

summary_with_export

export_format

enum<string>

default:csv

The export's file format. Applies only with response_mode=summary_with_export. Events, data points and assets also export to xlsx.

Available options:

csv,

json,

xlsx

Response

200

List all events on a project

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

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

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/events', 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",
  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"

	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))

}

require 'uri'
require 'net/http'

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

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

{
  "data": [
    {
      "id": "evt_mNoP3456qRsT7890",
      "slug": "biochar-delivery",
      "event_type": "Biochar Delivery",
      "tracking_id": "MG1003",
      "start_time": "2024-06-04T00:00:00.000Z",
      "end_time": "2024-06-04T23:59:59.000Z",
      "data_points": [
        {
          "id": "in_mNoP3456qRsT7890",
          "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"
        },
        {
          "id": "in_uVwX1234yZaB5678",
          "slug": "distance-biochar-transported",
          "data_point_type": "Biochar distance transported",
          "value": 15.3,
          "unit": "mile",
          "status": "complete"
        },
        {
          "id": "in_cDeF9012gHiJ3456",
          "slug": "biochar-end-use",
          "data_point_type": "Biochar end use",
          "value": "soil amendment",
          "unit": null,
          "status": "complete"
        }
      ],
      "locations": [
        {
          "id": "loc_mNoP3456qRsT7890",
          "lat": "40.4773493",
          "long": "-124.1226179",
          "name": "Production Facility",
          "address": {
            "name": "Production Facility",
            "street_address_1": null,
            "street_address_2": null,
            "city": null,
            "state": null,
            "postal_code": null,
            "country": "CA"
          }
        },
        {
          "id": "loc_mNoP3456qRsT7890",
          "lat": "41.2733453",
          "long": "-122.2246676",
          "name": "Customer Location",
          "address": {
            "name": "Customer Location",
            "street_address_1": null,
            "street_address_2": null,
            "city": null,
            "state": null,
            "postal_code": null,
            "country": "CA"
          }
        }
      ],
      "evidences": [
        {
          "id": 1,
          "url": "XXXXXXX",
          "evidence_type": "file",
          "name": "Receipt.pdf"
        }
      ]
    }
  ],
  "info": {
    "items": 10,
    "page_size": 10,
    "total_items": 120105,
    "current_page": 1,
    "next_page": 2,
    "previous_page": null,
    "total_pages": 12011,
    "sort": [
      {
        "field": "start_time",
        "direction": "desc"
      }
    ],
    "filter": [
      {
        "field": "status",
        "operator": "eq",
        "value": "complete"
      }
    ]
  }
}

{
  "status": "error",
  "statusCode": 404,
  "errors": [
    {
      "message": "record not found"
    }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Authorizations

Path Parameters

Query Parameters

Response