List report definitions.
GET
/api/workspace/admin/reporting/reports
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Get, RequestUri = new Uri("https://example.com/api/workspace/admin/reporting/reports"), Headers = { { "Authorization", "Bearer <token>" }, },};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://example.com/api/workspace/admin/reporting/reports';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/workspace/admin/reporting/reports \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”access_token
string
Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.
Responses
Section titled “Responses”OK
Media typeapplication/json
object
Data
Array<object>
Report definition summary.
object
Id
Definition id.
string
Key
Definition key.
string
Title
Definition title.
string
Description
Definition description.
string
State
Lifecycle state for a dashboard or report definition.
integer format: int32
Navigator
Report navigator metadata used by the dynamic report navigator.
object
Category
Navigator category.
string
Group
Navigator group.
string
Icon
Navigator icon.
string
Priority
Navigator ordering priority.
integer format: int32
Tags
Searchable tags.
Array<string>
Featured
Whether the report is featured.
boolean
SearchText
Optional additional search text.
string
PublishedVersionNumber
Current published version number.
integer format: int32
ModifiedAt
Last modification timestamp.
string format: date-time
RowVersion
Optimistic concurrency token.
string format: uuid
Errors
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Warnings
Array<object>
object
Code
required
string
Message
required
string
Target
string
Field
string
Metadata
object
key
additional properties
string
Type
integer format: int32
Severity
integer format: int32
Success
boolean
Example
{ "Data": [ { "State": 0 } ], "Errors": [ { "Type": 0, "Severity": 0 } ], "Warnings": [ { "Type": 0, "Severity": 0 } ]}Forbidden
Media typeapplication/json
object
type
string
title
string
status
integer format: int32
detail
string
instance
string
key
additional properties
Examplegenerated
{ "type": "example", "title": "example", "status": 1, "detail": "example", "instance": "example"}