Search Report History

POST /api/content/v1/reportschedules/history/search

Search Report History

cURL

curl --request POST \
  --url https://{instance}.domo.com/api/content/v1/reportschedules/history/search \
  --header 'Content-Type: application/json' \
  --header 'X-DOMO-Developer-Token: <api-key>' \
  --data '
{
  "includeTitleClause": true,
  "titleSearchText": "Sales",
  "includeStatusClause": true,
  "status": "success",
  "includeTypeClause": true,
  "isAutomated": true,
  "includeScheduleIdClause": false
}
'

import requests

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

payload = {
    "includeTitleClause": True,
    "titleSearchText": "Sales",
    "includeStatusClause": True,
    "status": "success",
    "includeTypeClause": True,
    "isAutomated": True,
    "includeScheduleIdClause": False
}
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({
    includeTitleClause: true,
    titleSearchText: 'Sales',
    includeStatusClause: true,
    status: 'success',
    includeTypeClause: true,
    isAutomated: true,
    includeScheduleIdClause: false
  })
};

fetch('https://{instance}.domo.com/api/content/v1/reportschedules/history/search', 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/history/search",
  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([
    'includeTitleClause' => true,
    'titleSearchText' => 'Sales',
    'includeStatusClause' => true,
    'status' => 'success',
    'includeTypeClause' => true,
    'isAutomated' => true,
    'includeScheduleIdClause' => false
  ]),
  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/history/search"

	payload := strings.NewReader("{\n  \"includeTitleClause\": true,\n  \"titleSearchText\": \"Sales\",\n  \"includeStatusClause\": true,\n  \"status\": \"success\",\n  \"includeTypeClause\": true,\n  \"isAutomated\": true,\n  \"includeScheduleIdClause\": false\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/history/search")
  .header("X-DOMO-Developer-Token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"includeTitleClause\": true,\n  \"titleSearchText\": \"Sales\",\n  \"includeStatusClause\": true,\n  \"status\": \"success\",\n  \"includeTypeClause\": true,\n  \"isAutomated\": true,\n  \"includeScheduleIdClause\": false\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"includeTitleClause\": true,\n  \"titleSearchText\": \"Sales\",\n  \"includeStatusClause\": true,\n  \"status\": \"success\",\n  \"includeTypeClause\": true,\n  \"isAutomated\": true,\n  \"includeScheduleIdClause\": false\n}"

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

200

[
  {
    "id": 123456,
    "reportTitle": "Sales Report",
    "startTime": "2024-11-14T10:00:00Z",
    "endTime": "2024-11-14T10:05:00Z",
    "automated": true,
    "status": "success"
  }
]

Authorizations

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

Query Parameters

filter · string · default: USER

Filter type

limit · integer · default: 100

Number of items to return

skip · integer · default: 0

Number of items to skip

orderBy · enum<string> · default: startTime

Field to sort by

Available options: reportTitle, startTime, endTime, automated, cardCount, attachmentCount, attachmentSize, emailSize

isAscending · boolean · default: false

Sort order

Body

application/json

ReportLogSearchCriteria object

includeTitleClause · boolean

titleSearchText · string

includeStatusClause · boolean

status · string

includeTypeClause · boolean

isAutomated · boolean

includeScheduleIdClause · boolean

Response

200

application/json

OK