API Reference/Reports/Definitions

Get report definitions

GET
/api/reports/definitions
AuthorizationBearer <token>

In: header

Query Parameters

reportType?string
Value in"compliance" | "activity" | "performance" | "custom"
isPublic?boolean

Response Body

curl -X GET "http://localhost:3000/api/reports/definitions?reportType=compliance&isPublic=true"
fetch("http://localhost:3000/api/reports/definitions?reportType=compliance&isPublic=true")
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "http://localhost:3000/api/reports/definitions?reportType=compliance&isPublic=true"

  req, _ := http.NewRequest("GET", url, nil)
  
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "http://localhost:3000/api/reports/definitions?reportType=compliance&isPublic=true"

response = requests.request("GET", url)

print(response.text)
{
  "reportDefinitions": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "reportType": "string",
      "executionCount": 0
    }
  ]
}