cURL
curl --request GET \
--url https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary', 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.useanima.sh/v1/orgs/{orgId}/compliance/summary",
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: Bearer <token>"
],
]);
$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 := "https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"framework": "<string>",
"totalControls": 123,
"byStatus": {},
"byCategory": {},
"overallProgress": 50,
"expiredEvidenceCount": 123
}API Reference
Get orgs compliancesummary
GET
/
orgs
/
{orgId}
/
compliance
/
summary
cURL
curl --request GET \
--url https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary', 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.useanima.sh/v1/orgs/{orgId}/compliance/summary",
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: Bearer <token>"
],
]);
$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 := "https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useanima.sh/v1/orgs/{orgId}/compliance/summary")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"framework": "<string>",
"totalControls": 123,
"byStatus": {},
"byCategory": {},
"overallProgress": 50,
"expiredEvidenceCount": 123
}Authorizations
BearerAuthApiKeyAuth
JWT Bearer token obtained from authentication. Pass as: Authorization: Bearer
Path Parameters
Organization identifier
Query Parameters
Framework to summarize
Available options:
SOC2, GDPR, PCI Response
200 - application/json
OK
Compliance framework summary
Framework identifier
Total number of controls
Count of controls by status
Show child attributes
Show child attributes
Breakdown by category
Show child attributes
Show child attributes
Overall implementation progress percentage
Required range:
0 <= x <= 100Number of expired evidence items
