Data Feeds

Update a data feed's schema

Defines or replaces the column schema for a data feed. Each field must have a name (the CSV column header) and a value_type (string, number, or boolean). The submitted list replaces the whole schema, so send every column. An omitted schema_fields counts as an empty list: it clears the schema and creates a new version of the feed. If the submitted schema and header row match the current ones, the call succeeds as a no-op.

A data feed is not ready to accept data until a schema is defined; an empty schema counts as defined. Requires the read:project and write:data_feed token scopes.

PATCH

projects

{project_id}

data_feeds

{data_feed_id}

update_schema

Update a data feed's schema

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_fields": [
    {
      "name": "site_name",
      "value_type": "string"
    },
    {
      "name": "reading",
      "value_type": "number"
    },
    {
      "name": "is_active",
      "value_type": "boolean"
    }
  ]
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema"

payload = { "schema_fields": [
        {
            "name": "site_name",
            "value_type": "string"
        },
        {
            "name": "reading",
            "value_type": "number"
        },
        {
            "name": "is_active",
            "value_type": "boolean"
        }
    ] }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    schema_fields: [
      {name: 'site_name', value_type: 'string'},
      {name: 'reading', value_type: 'number'},
      {name: 'is_active', value_type: 'boolean'}
    ]
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema', 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}/data_feeds/{data_feed_id}/update_schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schema_fields' => [
        [
                'name' => 'site_name',
                'value_type' => 'string'
        ],
        [
                'name' => 'reading',
                'value_type' => 'number'
        ],
        [
                'name' => 'is_active',
                'value_type' => 'boolean'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema"

	payload := strings.NewReader("{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}"

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

{
  "id": "datafd_aBcD1234eFgH5678",
  "name": "Daily Production Data",
  "description": "Imports daily production metrics",
  "headers_row_number": 1,
  "setup_error": "<string>",
  "not_ready_message": null,
  "schema_fields": [
    {
      "name": "site_name",
      "value_type": "string"
    }
  ],
  "event_types": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>"
    }
  ],
  "transformations": [
    {
      "id": "tfn_aBcD1234eFgH5678",
      "event_type_id": "et_aBcD1234eFgH5678",
      "event_type_name": "<string>",
      "script_status": "generating",
      "script_content": "<string>"
    }
  ],
  "sources": [
    {
      "id": "dsrc_aBcD1234eFgH5678",
      "name": "<string>",
      "source_type": "endpoint",
      "config": {}
    }
  ],
  "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/data-feeds/datafd_aBcD1234eFgH5678",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Path Parameters

project_id

string

required

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

data_feed_id

string

required

The data feed's friendly ID (e.g. datafd_aBcD1234eFgH5678).

Body

application/json

schema_fields

object[]

Show child attributes

headers_row_number

integer | null

Row number (1-based) containing column headers. Rows above are ignored during ingestion. Omit to preserve the current value; send null to reset to row 1.

Required range: x >= 1

Example:

14

Response

Schema updated. Returns the updated data feed.

A data feed. List rows omit each transformation's script_content and each source's config; single-feed responses include them.

string

The data feed's friendly ID.

Example:

"datafd_aBcD1234eFgH5678"

name

string

Example:

"Daily Production Data"

description

string | null

Example:

"Imports daily production metrics"

headers_row_number

integer

Row number (1-based) containing column headers. Rows above are ignored during ingestion. 1 until a schema sets another value.

Example:

1

setup_error

string | null

Why automatic setup could not build the schema (for example an unreadable sample file), or null.

not_ready_message

string | null

Why the feed cannot accept data yet, or null when it is ready. A new feed reports "Transformation scripts are still being generated" until its scripts are drafted, and "Schema not defined" until a schema exists.

Example:

null

schema_fields

object[]

The columns of the current schema. Empty until a schema is defined.

Show child attributes

event_types

object[]

The event types the feed's active transformations create.

Show child attributes

transformations

object[]

Active (unarchived) transformations, one per event type.

Show child attributes

sources

object[]

Show child attributes

ui_url

string<uri>

Link to the data feed's page in the app.

Example:

"https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/data-feeds/datafd_aBcD1234eFgH5678"

created_at

string<date-time>

updated_at

string<date-time>

Update a data feed's schema

curl --request PATCH \
  --url https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "schema_fields": [
    {
      "name": "site_name",
      "value_type": "string"
    },
    {
      "name": "reading",
      "value_type": "number"
    },
    {
      "name": "is_active",
      "value_type": "boolean"
    }
  ]
}
'

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema"

payload = { "schema_fields": [
        {
            "name": "site_name",
            "value_type": "string"
        },
        {
            "name": "reading",
            "value_type": "number"
        },
        {
            "name": "is_active",
            "value_type": "boolean"
        }
    ] }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    schema_fields: [
      {name: 'site_name', value_type: 'string'},
      {name: 'reading', value_type: 'number'},
      {name: 'is_active', value_type: 'boolean'}
    ]
  })
};

fetch('https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema', 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}/data_feeds/{data_feed_id}/update_schema",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schema_fields' => [
        [
                'name' => 'site_name',
                'value_type' => 'string'
        ],
        [
                'name' => 'reading',
                'value_type' => 'number'
        ],
        [
                'name' => 'is_active',
                'value_type' => 'boolean'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema"

	payload := strings.NewReader("{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://app.gomangrove.com/api/v1/projects/{project_id}/data_feeds/{data_feed_id}/update_schema")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schema_fields\": [\n    {\n      \"name\": \"site_name\",\n      \"value_type\": \"string\"\n    },\n    {\n      \"name\": \"reading\",\n      \"value_type\": \"number\"\n    },\n    {\n      \"name\": \"is_active\",\n      \"value_type\": \"boolean\"\n    }\n  ]\n}"

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

{
  "id": "datafd_aBcD1234eFgH5678",
  "name": "Daily Production Data",
  "description": "Imports daily production metrics",
  "headers_row_number": 1,
  "setup_error": "<string>",
  "not_ready_message": null,
  "schema_fields": [
    {
      "name": "site_name",
      "value_type": "string"
    }
  ],
  "event_types": [
    {
      "id": 123,
      "name": "<string>",
      "slug": "<string>"
    }
  ],
  "transformations": [
    {
      "id": "tfn_aBcD1234eFgH5678",
      "event_type_id": "et_aBcD1234eFgH5678",
      "event_type_name": "<string>",
      "script_status": "generating",
      "script_content": "<string>"
    }
  ],
  "sources": [
    {
      "id": "dsrc_aBcD1234eFgH5678",
      "name": "<string>",
      "source_type": "endpoint",
      "config": {}
    }
  ],
  "ui_url": "https://app.gomangrove.com/nexus/prj_aBcD1234eFgH5678/data-inputs/data-feeds/datafd_aBcD1234eFgH5678",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Update a data feed's schema

Authorizations

Path Parameters

Body

Response