Get review disagreement state
curl --request POST \
--url https://api.coval.dev/v1/review-projects/disagreement-state \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_ids": [
"01KRPCANWQVHVZ48YEMJ70VK52"
],
"include_unresolved_ids": true
}
'import requests
url = "https://api.coval.dev/v1/review-projects/disagreement-state"
payload = {
"project_ids": ["01KRPCANWQVHVZ48YEMJ70VK52"],
"include_unresolved_ids": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({project_ids: ['01KRPCANWQVHVZ48YEMJ70VK52'], include_unresolved_ids: true})
};
fetch('https://api.coval.dev/v1/review-projects/disagreement-state', 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.coval.dev/v1/review-projects/disagreement-state",
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([
'project_ids' => [
'01KRPCANWQVHVZ48YEMJ70VK52'
],
'include_unresolved_ids' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.coval.dev/v1/review-projects/disagreement-state"
payload := strings.NewReader("{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.coval.dev/v1/review-projects/disagreement-state")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/review-projects/disagreement-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}"
response = http.request(request)
puts response.read_body{
"projects": [
{
"project_id": "<string>",
"unresolved_simulation_count": 123,
"unresolved_simulation_ids": [
"<string>"
],
"unresolved_annotation_ids": [
"<string>"
]
}
]
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request body",
"details": [
{
"field": "simulation_output_id",
"description": "simulation_output_id is required"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "The API key does not include the required reviews permission."
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Service temporarily unavailable",
"details": [
{
"description": "Database routing is temporarily unavailable. Please retry."
}
]
}
}Reviews
Get review disagreement state
Compact unresolved-disagreement state for review-note enforcement, for a set of review projects. Only projects with the require_disagreement_notes rule are reported. Issued via POST because the project id set is supplied in the body. Latency scales with the total scanned simulations x metrics across the requested projects.
POST
/
review-projects
/
disagreement-state
Get review disagreement state
curl --request POST \
--url https://api.coval.dev/v1/review-projects/disagreement-state \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"project_ids": [
"01KRPCANWQVHVZ48YEMJ70VK52"
],
"include_unresolved_ids": true
}
'import requests
url = "https://api.coval.dev/v1/review-projects/disagreement-state"
payload = {
"project_ids": ["01KRPCANWQVHVZ48YEMJ70VK52"],
"include_unresolved_ids": True
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({project_ids: ['01KRPCANWQVHVZ48YEMJ70VK52'], include_unresolved_ids: true})
};
fetch('https://api.coval.dev/v1/review-projects/disagreement-state', 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.coval.dev/v1/review-projects/disagreement-state",
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([
'project_ids' => [
'01KRPCANWQVHVZ48YEMJ70VK52'
],
'include_unresolved_ids' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.coval.dev/v1/review-projects/disagreement-state"
payload := strings.NewReader("{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.coval.dev/v1/review-projects/disagreement-state")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.coval.dev/v1/review-projects/disagreement-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"project_ids\": [\n \"01KRPCANWQVHVZ48YEMJ70VK52\"\n ],\n \"include_unresolved_ids\": true\n}"
response = http.request(request)
puts response.read_body{
"projects": [
{
"project_id": "<string>",
"unresolved_simulation_count": 123,
"unresolved_simulation_ids": [
"<string>"
],
"unresolved_annotation_ids": [
"<string>"
]
}
]
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request body",
"details": [
{
"field": "simulation_output_id",
"description": "simulation_output_id is required"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "X-API-Key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "PERMISSION_DENIED",
"message": "Insufficient permissions",
"details": [
{
"field": "permissions",
"description": "The API key does not include the required reviews permission."
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Service temporarily unavailable",
"details": [
{
"description": "Database routing is temporarily unavailable. Please retry."
}
]
}
}Authorizations
Organization API key for authentication
Body
application/json
Review project IDs (ULIDs). Projects without the require_disagreement_notes rule are ignored.
Required array length:
1 - 1000 elementsWhen set with include_unresolved_ids, only this project returns its id lists.
Include the unresolved simulation/annotation id lists (otherwise counts only).
Response
Disagreement state computed successfully
Show child attributes
Show child attributes
Was this page helpful?
⌘I