Create Report Schedule

POST /api/content/v1/reportschedules

Create Report Schedule

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/content/v1/reportschedules \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "title": "Weekly Performance Report",
  "pageId": 345678,
  "viewId": 789012,
  "schedule": {
    "frequency": "WEEKLY",
    "daysToRun": "MON",
    "hourOfDay": 8,
    "minOfHour": 0,
    "timezone": "America/New_York",
    "enabled": true,
    "additionalRecipients": [
      {
        "type": "EMAIL",
        "value": "[e-mail]"
      }
    ]
  },
  "attachmentInclude": true
}
'

import requests

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

payload = {
    "title": "Weekly Performance Report",
    "pageId": 345678,
    "viewId": 789012,
    "schedule": {
        "frequency": "WEEKLY",
        "daysToRun": "MON",
        "hourOfDay": 8,
        "minOfHour": 0,
        "timezone": "America/New_York",
        "enabled": True,
        "additionalRecipients": [
            {
                "type": "EMAIL",
                "value": "[e-mail]"
            }
        ]
    },
    "attachmentInclude": True
}
headers = {
    "X-DOMO-Developer-Token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-DOMO-Developer-Token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    title: 'Weekly Performance Report',
    pageId: 345678,
    viewId: 789012,
    schedule: {
      frequency: 'WEEKLY',
      daysToRun: 'MON',
      hourOfDay: 8,
      minOfHour: 0,
      timezone: 'America/New_York',
      enabled: true,
      additionalRecipients: [{type: 'EMAIL', value: '[e-mail]'}]
    },
    attachmentInclude: true
  })
};

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 => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'title' => 'Weekly Performance Report',
    'pageId' => 345678,
    'viewId' => 789012,
    'schedule' => [
        'frequency' => 'WEEKLY',
        'daysToRun' => 'MON',
        'hourOfDay' => 8,
        'minOfHour' => 0,
        'timezone' => 'America/New_York',
        'enabled' => true,
        'additionalRecipients' => [
                [
                                'type' => 'EMAIL',
                                'value' => '[e-mail]'
                ]
        ]
    ],
    'attachmentInclude' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"title\": \"Weekly Performance Report\",\n  \"pageId\": 345678,\n  \"viewId\": 789012,\n  \"schedule\": {\n    \"frequency\": \"WEEKLY\",\n    \"daysToRun\": \"MON\",\n    \"hourOfDay\": 8,\n    \"minOfHour\": 0,\n    \"timezone\": \"America/New_York\",\n    \"enabled\": true,\n    \"additionalRecipients\": [\n      {\n        \"type\": \"EMAIL\",\n        \"value\": \"[e-mail]\"\n      }\n    ]\n  },\n  \"attachmentInclude\": true\n}")

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

	req.Header.Add("X-DOMO-Developer-Token", "<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.post("https://{instance}.domo.com/api/content/v1/reportschedules")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Weekly Performance Report\",\n  \"pageId\": 345678,\n  \"viewId\": 789012,\n  \"schedule\": {\n    \"frequency\": \"WEEKLY\",\n    \"daysToRun\": \"MON\",\n    \"hourOfDay\": 8,\n    \"minOfHour\": 0,\n    \"timezone\": \"America/New_York\",\n    \"enabled\": true,\n    \"additionalRecipients\": [\n      {\n        \"type\": \"EMAIL\",\n        \"value\": \"[e-mail]\"\n      }\n    ]\n  },\n  \"attachmentInclude\": true\n}")
  .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::Post.new(url)
request["X-DOMO-Developer-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"title\": \"Weekly Performance Report\",\n  \"pageId\": 345678,\n  \"viewId\": 789012,\n  \"schedule\": {\n    \"frequency\": \"WEEKLY\",\n    \"daysToRun\": \"MON\",\n    \"hourOfDay\": 8,\n    \"minOfHour\": 0,\n    \"timezone\": \"America/New_York\",\n    \"enabled\": true,\n    \"additionalRecipients\": [\n      {\n        \"type\": \"EMAIL\",\n        \"value\": \"[e-mail]\"\n      }\n    ]\n  },\n  \"attachmentInclude\": true\n}"

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

200

{
  "id": 123457,
  "reportViewId": 789012,
  "pageId": 345678,
  "title": "Weekly Performance Report",
  "schedule": {
    "frequency": "WEEKLY",
    "daysToRun": "MON",
    "hourOfDay": 8,
    "minOfHour": 0,
    "enabled": true,
    "nextRunDate": 1700481600000
  }
}

Authorizations

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

Body

application/json

ReportScheduleInfo object

title · string

pageId · integer

viewId · integer

schedule · object

Show child attributes

attachmentInclude · boolean

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