List all inputs of a batch

GET

batches

{batch_id}

inputs

curl --request GET \
  --url https://app.gomangrove.com/api/v1/batches/{batch_id}/inputs \
  --header 'Authorization: <api-key>'

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

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

	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/batches/{batch_id}/inputs")

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": [
    {
      "data_point": {
        "id": "<string>",
        "slug": "<string>",
        "data_point_type": "<string>",
        "value": 123,
        "unit": "<string>",
        "status": "<string>",
        "substituted": true,
        "imputed": true,
        "raw_value": 123,
        "substitution": {
          "source": "manual",
          "method": "manual_entry",
          "from_value": 123,
          "to_value": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "Example User",
          "rule": {
            "name": "Feedstock volume within expected range",
            "friendly_id": "rule_aBcD1234eFgH5678"
          }
        }
      },
      "event": {
        "id": "<string>",
        "slug": "<string>",
        "event_type": "<string>",
        "tracking_id": "<string>",
        "start_time": "2023-11-07T05:31:56Z",
        "end_time": "2023-11-07T05:31:56Z",
        "project_id": "<string>"
      }
    }
  ],
  "info": {
    "items": 2,
    "page_size": 20,
    "total_items": 2,
    "current_page": 1,
    "next_page": 123,
    "previous_page": 123,
    "total_pages": 1,
    "sort": [
      {
        "field": "<string>",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "field": "<string>",
        "comparator": "eq",
        "value": "<unknown>"
      }
    ],
    "fields": [
      "<string>"
    ]
  }
}

{
  "errors": [
    {
      "message": "<string>",
      "field": "<string>",
      "code": "<string>",
      "blocking": [
        {
          "type": "<string>",
          "friendly_id": "<string>",
          "name": "<string>"
        }
      ],
      "blocking_count": 123,
      "config_key": "<string>",
      "count": 123,
      "value": "<unknown>"
    }
  ]
}

{
  "errors": [
    {
      "message": "API token has expired"
    }
  ]
}

{
  "errors": [
    {
      "message": "You are not authorized to perform this action"
    }
  ]
}

{
  "errors": [
    {
      "message": "Record not found"
    }
  ]
}

Authorizations

Authorization

string

header

required

Path Parameters

batch_id

string

required

The batch's friendly ID (e.g. ba_aBcD1234eFgH5678).

Query Parameters

page

integer<int32>

default:1

The page to return, starting at 1. A value below 1 or a non-numeric value returns 400.

Required range: x >= 1

page_size

integer<int32>

default:20

Rows per page, from 1 to 200. A value below 1 counts as 1 and a value above 200 as 200; a non-numeric value uses the default.

Required range: 1 <= x <= 200

sort

string

Sortable fields: id, start_time, end_time, created_at, updated_at, status.

fields

string

Comma-separated sections to return in each row: data_point, event. Any other name returns 400.

response_mode

enum<string>

default returns a page of rows. summary returns the number of matching records and up to 10 sample rows. This endpoint doesn't support summary_with_export, which returns 400.

Available options:

default,

summary

filter[slug]

string

Only inputs whose data point type has this slug. Supports only eq, and is also accepted as a top-level slug parameter; sending both with different values returns 400.

filter[status]

string

Only inputs with this data point status. Filterable fields: slug, status, start_time, end_time.

Response

A page of the batch's inputs. With response_mode=summary, a count and up to 10 samples instead.

Option 1
Option 2

data

object[]

required

Show child attributes

info

object

required

Where this page sits in the full result, and the sort, filters and fields the request applied.

Show child attributes

List all inputs of a batch

curl --request GET \
  --url https://app.gomangrove.com/api/v1/batches/{batch_id}/inputs \
  --header 'Authorization: <api-key>'

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

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

	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/batches/{batch_id}/inputs")

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": [
    {
      "data_point": {
        "id": "<string>",
        "slug": "<string>",
        "data_point_type": "<string>",
        "value": 123,
        "unit": "<string>",
        "status": "<string>",
        "substituted": true,
        "imputed": true,
        "raw_value": 123,
        "substitution": {
          "source": "manual",
          "method": "manual_entry",
          "from_value": 123,
          "to_value": 123,
          "created_at": "2023-11-07T05:31:56Z",
          "created_by": "Example User",
          "rule": {
            "name": "Feedstock volume within expected range",
            "friendly_id": "rule_aBcD1234eFgH5678"
          }
        }
      },
      "event": {
        "id": "<string>",
        "slug": "<string>",
        "event_type": "<string>",
        "tracking_id": "<string>",
        "start_time": "2023-11-07T05:31:56Z",
        "end_time": "2023-11-07T05:31:56Z",
        "project_id": "<string>"
      }
    }
  ],
  "info": {
    "items": 2,
    "page_size": 20,
    "total_items": 2,
    "current_page": 1,
    "next_page": 123,
    "previous_page": 123,
    "total_pages": 1,
    "sort": [
      {
        "field": "<string>",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "field": "<string>",
        "comparator": "eq",
        "value": "<unknown>"
      }
    ],
    "fields": [
      "<string>"
    ]
  }
}

{
  "errors": [
    {
      "message": "<string>",
      "field": "<string>",
      "code": "<string>",
      "blocking": [
        {
          "type": "<string>",
          "friendly_id": "<string>",
          "name": "<string>"
        }
      ],
      "blocking_count": 123,
      "config_key": "<string>",
      "count": 123,
      "value": "<unknown>"
    }
  ]
}

{
  "errors": [
    {
      "message": "API token has expired"
    }
  ]
}

{
  "errors": [
    {
      "message": "You are not authorized to perform this action"
    }
  ]
}

{
  "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