Preview batch generation - Mangrove Documentation

POST

ledgers

{ledger_id}

generate_preview

Preview batch generation

curl --request POST \
  --url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/generate_preview \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z"
}
'

{
  "data": [
    {
      "id": "lgr_abc123def456",
      "name": "Net Carbon Removal",
      "count": 3
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

ledger_id

string

required

Ledger friendly ID (e.g., lgr_abc123def456)

Body

application/json

start_time

string<date-time>

required

Start of the time range

end_time

string<date-time>

required

End of the time range

data_point_ids

string[]

Optional array of data point friendly IDs. If omitted, auto-discovers from time range.

Response

200 - application/json

200

data

object[]

Show child attributes

Create batch generationTriggers an async batch generation job for the given time range.

Preview batch generation

curl --request POST \
  --url https://app.gomangrove.com/api/v1/ledgers/{ledger_id}/generate_preview \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "start_time": "2025-01-01T00:00:00.000Z",
  "end_time": "2025-03-31T23:59:59.000Z"
}
'

{
  "data": [
    {
      "id": "lgr_abc123def456",
      "name": "Net Carbon Removal",
      "count": 3
    }
  ]
}