Retrieve dashboard report settings by report ID

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}",
  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: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "message": "<string>",
  "format": "PDF",
  "destinationType": "EMAIL/FILE_DROP",
  "type": "RAW_DATA_FOR_VISUAL",
  "recipients": {
    "users": [
      {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    ]
  },
  "schedule": {
    "frequency": "ONCE",
    "minutesOfHour": 15,
    "dayOfMonth": 1,
    "dayOfWeek": "MONDAY",
    "daysOfWeek": [
      "MONDAY"
    ],
    "monthsOfYear": "[JANUARY] or [MAY, DECEMBER]",
    "timeOfDay": "17:30:00",
    "startTimeOfDay": "16:00:00",
    "endTimeOfDay": "18:00:00",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "timezone": "America/New_York"
  },
  "columnCount": 123,
  "ssrScheduleProperties": {
    "id": "<string>",
    "columnCount": 123,
    "fontSize": 123,
    "pageSize": "LETTER",
    "orientation": "PORTRAIT"
  }
}

Retrieve dashboard report settings by report ID

curl --request GET \
  --url http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}",
  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: Basic <encoded-value>"
  ],
]);

$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 := "http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

	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("http://10.2.4.166:8080/composer/api/dashboards/{dashboardId}/reports/{reportId}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "id": "<string>",
  "name": "<string>",
  "subject": "<string>",
  "message": "<string>",
  "format": "PDF",
  "destinationType": "EMAIL/FILE_DROP",
  "type": "RAW_DATA_FOR_VISUAL",
  "recipients": {
    "users": [
      {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    ]
  },
  "schedule": {
    "frequency": "ONCE",
    "minutesOfHour": 15,
    "dayOfMonth": 1,
    "dayOfWeek": "MONDAY",
    "daysOfWeek": [
      "MONDAY"
    ],
    "monthsOfYear": "[JANUARY] or [MAY, DECEMBER]",
    "timeOfDay": "17:30:00",
    "startTimeOfDay": "16:00:00",
    "endTimeOfDay": "18:00:00",
    "startDate": "2023-12-25",
    "endDate": "2023-12-25",
    "timezone": "America/New_York"
  },
  "columnCount": 123,
  "ssrScheduleProperties": {
    "id": "<string>",
    "columnCount": 123,
    "fontSize": 123,
    "pageSize": "LETTER",
    "orientation": "PORTRAIT"
  }
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Path Parameters

dashboardId

string

required

Dashboard ID

reportId

string

required

Report ID

Response

200 - application/vnd.composer.v3+json

string

name

string

subject

string

message

string

format

enum<string>

Available options:

PDF,

PNG,

XLSX,

SSR_PDF,

SSR_XLSX

destinationType

enum<string>

Destination for the report

Available options:

EMAIL,

FILE_DROP

Example:

"EMAIL/FILE_DROP"

type

enum<string>

Data export type for XLSX reports

Available options:

RAW_DATA_FOR_VISUAL,

VISUAL_DATA

recipients

object

Show child attributes

schedule

object

Show child attributes

columnCount

integer<int32>

deprecated

Number of columns to be exported for Self Service Report

ssrScheduleProperties

object

Defines self service report details for the schedule

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Retrieve dashboard report settings by report ID

Authorizations

Path Parameters

Response