Retrieve a data request schedule

GET

projects

{project_id}

data_requests

{data_request_id}

schedule

Get the schedule for a data request

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

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{data_request_id}/schedule"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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}/data_requests/{data_request_id}/schedule")

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

{
  "id": "sch_AaBbCcDdEeFfGgHh",
  "status": "active",
  "recurrence_rule": {
    "type": "daily",
    "interval": 2
  },
  "starts_at": "2023-11-07T05:31:56Z",
  "next_execution_at": "2023-11-07T05:31:56Z",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "end_condition": "never",
  "end_date": "2023-12-25",
  "max_occurrences": 123,
  "execution_count": 123,
  "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_request_id

string

required

The data request's friendly ID (e.g. req_aBcD1234eFgH5678).

Pattern: ^req_[A-Za-z0-9]{16}$

Response

string

Example:

"sch_AaBbCcDdEeFfGgHh"

status

enum<string>

completed once the schedule has finished or been cancelled.

Available options:

active,

paused,

completed

recurrence_rule

object | null

Null for one-off schedules.

Show child attributes

starts_at

string<date-time> | null

The first next_execution_at the schedule was created with.

next_execution_at

string<date-time> | null

Null once the schedule is completed.

last_executed_at

string<date-time> | null

end_condition

enum<string>

Available options:

never,

on_date,

after_count

end_date

string<date> | null

max_occurrences

integer | null

execution_count

integer

created_at

string<date-time>

updated_at

string<date-time>

Get the schedule for a data request

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

import requests

url = "https://app.gomangrove.com/api/v1/projects/{project_id}/data_requests/{data_request_id}/schedule"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

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

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

	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}/data_requests/{data_request_id}/schedule")

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

{
  "id": "sch_AaBbCcDdEeFfGgHh",
  "status": "active",
  "recurrence_rule": {
    "type": "daily",
    "interval": 2
  },
  "starts_at": "2023-11-07T05:31:56Z",
  "next_execution_at": "2023-11-07T05:31:56Z",
  "last_executed_at": "2023-11-07T05:31:56Z",
  "end_condition": "never",
  "end_date": "2023-12-25",
  "max_occurrences": 123,
  "execution_count": 123,
  "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

Authorizations

Path Parameters

Response