Get reporting by workspace
curl --request POST \
--url https://api.example.com/api/v2/reporting/by-workspace \
--header 'Content-Type: application/json' \
--data '
{
"metric": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"top": 123,
"workspaceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.example.com/api/v2/reporting/by-workspace"
payload = {
"metric": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"top": 123,
"workspaceIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
metric: '<string>',
from: '2023-12-25',
to: '2023-12-25',
top: 123,
workspaceIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.example.com/api/v2/reporting/by-workspace', 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://api.example.com/api/v2/reporting/by-workspace",
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([
'metric' => '<string>',
'from' => '2023-12-25',
'to' => '2023-12-25',
'top' => 123,
'workspaceIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/api/v2/reporting/by-workspace"
payload := strings.NewReader("{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/api/v2/reporting/by-workspace")
.header("Content-Type", "application/json")
.body("{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/reporting/by-workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"metric": "<string>",
"total": 123,
"workspaces": [
{
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"value": 123
}
],
"remainder": 123,
"otherWorkspaces": 123,
"read": {
"scope": "<string>",
"workspaceCount": 123,
"documentsRead": 123,
"fromCache": true,
"authorizeMs": 123,
"readMs": 123
}
},
"meta": {
"requestId": "<string>",
"timestamp": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}Reporting
Get reporting by workspace
POST
/
api
/
v2
/
reporting
/
by-workspace
Get reporting by workspace
curl --request POST \
--url https://api.example.com/api/v2/reporting/by-workspace \
--header 'Content-Type: application/json' \
--data '
{
"metric": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"top": 123,
"workspaceIds": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
}
'import requests
url = "https://api.example.com/api/v2/reporting/by-workspace"
payload = {
"metric": "<string>",
"from": "2023-12-25",
"to": "2023-12-25",
"top": 123,
"workspaceIds": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
metric: '<string>',
from: '2023-12-25',
to: '2023-12-25',
top: 123,
workspaceIds: ['3c90c3cc-0d44-4b50-8888-8dd25736052a']
})
};
fetch('https://api.example.com/api/v2/reporting/by-workspace', 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://api.example.com/api/v2/reporting/by-workspace",
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([
'metric' => '<string>',
'from' => '2023-12-25',
'to' => '2023-12-25',
'top' => 123,
'workspaceIds' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://api.example.com/api/v2/reporting/by-workspace"
payload := strings.NewReader("{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.example.com/api/v2/reporting/by-workspace")
.header("Content-Type", "application/json")
.body("{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/reporting/by-workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"metric\": \"<string>\",\n \"from\": \"2023-12-25\",\n \"to\": \"2023-12-25\",\n \"top\": 123,\n \"workspaceIds\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"metric": "<string>",
"total": 123,
"workspaces": [
{
"workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"value": 123
}
],
"remainder": 123,
"otherWorkspaces": 123,
"read": {
"scope": "<string>",
"workspaceCount": 123,
"documentsRead": 123,
"fromCache": true,
"authorizeMs": 123,
"readMs": 123
}
},
"meta": {
"requestId": "<string>",
"timestamp": "<string>"
}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"requestId": "<string>",
"timestamp": "<string>",
"target": "<string>",
"errors": {}
}Body
application/json
One metric by workspace over the range.
The metric to rank the workspaces by: received, closed, investigated, actions,
breached or atRisk.
The first day of the range, inclusive (UTC days). A range spans at most 366 days.
The last day of the range, inclusive (UTC days).
How many workspaces to name before the remainder, from 1 to 10; 6 when omitted.
The workspaces to read, at most 500; null or empty reads every workspace the caller may see. A service
account sees the workspaces it holds a role on.