List Report Schedules

GET /api/content/v1/reportschedules

List Report Schedules

cURL

curl --request GET \
  --url https://{instance}.domo.com/api/content/v1/reportschedules \
  --header 'X-DOMO-Developer-Token: <api-key>'

import requests

url = "https://{instance}.domo.com/api/content/v1/reportschedules"

headers = {"X-DOMO-Developer-Token": "<api-key>"}

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

print(response.text)

const options = {method: 'GET', headers: {'X-DOMO-Developer-Token': '<api-key>'}};

fetch('https://{instance}.domo.com/api/content/v1/reportschedules', 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://{instance}.domo.com/api/content/v1/reportschedules",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-DOMO-Developer-Token: <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://{instance}.domo.com/api/content/v1/reportschedules"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-DOMO-Developer-Token", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://{instance}.domo.com/api/content/v1/reportschedules")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.domo.com/api/content/v1/reportschedules")

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

request = Net::HTTP::Get.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'

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

200

[
  {
    "id": 123456,
    "reportViewId": 789012,
    "pageId": 345678,
    "title": "Monthly Sales Report",
    "viewName": "Sales Dashboard",
    "type": "RECURRING",
    "ownerId": 901234,
    "embedViewId": 567890,
    "owner": true,
    "cardCount": 5,
    "recipientCount": 10,
    "cardId": 234567,
    "schedule": {
      "frequency": "MONTHLY",
      "daysToRun": "1",
      "hourOfDay": 9,
      "minOfHour": 0,
      "timezone": "America/New_York",
      "enabled": true
    }
  }
]

Authorizations

X-DOMO-Developer-Token · string · header · required

Query Parameters

filter · string · default: USER

Filter type for the schedules

title · string · default: ""

Filter by title

limit · integer · default: 0

Number of items to return

skip · integer · default: 0

Number of items to skip

orderBy · enum<string> · default: startDate

Field to sort by

Available options: startDate, nextRunDate, title

isAscending · boolean · default: false

Sort in ascending order

Response

200

application/json

OK

id · integer

reportViewId · integer

pageId · integer

title · string

viewName · string

type · string

ownerId · integer

embedViewId · integer

owner · boolean

cardCount · integer

recipientCount · integer

cardId · integer

schedule · object

Show child attributes