Skip to main content
GET
/
projects
/
{project_id}
/
events
List all events on a project
curl --request GET \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/events \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "evt_DLnYvzbjSujNAvXE",
      "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",
      "has_rule_alerts": false,
      "data_points": [
        {
          "id": "in_JuGzRS08MbVSEkCj",
          "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",
          "rule_results": []
        },
        {
          "id": "in_c3krFTxCxJSQR5Rc",
          "slug": "distance-biochar-transported",
          "data_point_type": "Biochar distance transported",
          "value": 15.3,
          "unit": "mile",
          "status": "complete",
          "rule_results": []
        },
        {
          "id": "in_AIKqFEtr5OpAqram",
          "slug": "biochar-end-use",
          "data_point_type": "Biochar end use",
          "value": "soil amendment",
          "unit": null,
          "status": "complete",
          "rule_results": []
        }
      ],
      "locations": [
        {
          "id": "loc_8XF1QtGs79oX9A6k",
          "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_8XF1QtGs79oX9A6k",
          "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"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
project_id
string
required

Query Parameters

​
page
integer<int32>
default:1

Page number to return.

​
page_size
integer<int32>
default:10

Number of events to return per page.

​
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

Example:

"-start_time,created_at"

​
filter[id][eq]
integer
​
filter[status][eq]
enum<string>
Available options:
complete,
incomplete,
pending
​
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[nexus_event_type_id][eq]
integer

Filter events by event type ID

​
filter[feedstock_id][eq]
integer
​
filter[nexus_events_data_source_id][eq]
integer

Filter events tied to a specific ingest job/data source

​
response_mode
enum<string>

Controls response format. default returns paginated data. summary returns count and 10 samples. summary_with_export returns summary and triggers an async export.

Available options:
default,
summary,
summary_with_export
​
export_format
enum<string>
default:csv

File format for async export (only with response_mode=summary_with_export). Default: csv.

Available options:
csv,
json

Response

200