Reports
Observations
Retrieves information on all the report’s filterables and the various calculations done on their options that identify segments of interest.
The filterables returned are in a specific sort order:
- has_presentable_calculations DESC (True->False)
- is_noteworthy DESC (True->False)
- largest_apex_delta DESC
GET
/
api
/
v1
/
reports
/
{id}
/
observations
/
Observations
curl --request GET \
--url https://api.main.apexscore.ai/api/v1/reports/{id}/observations/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.main.apexscore.ai/api/v1/reports/{id}/observations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.main.apexscore.ai/api/v1/reports/{id}/observations/', 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.main.apexscore.ai/api/v1/reports/{id}/observations/",
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.main.apexscore.ai/api/v1/reports/{id}/observations/"
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.main.apexscore.ai/api/v1/reports/{id}/observations/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.main.apexscore.ai/api/v1/reports/{id}/observations/")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configuration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"state": {
"status_message": "<string>",
"observations_data_pending": "<string>",
"text_analysis_data_pending": "<string>"
}
},
"filterables": [
{
"content": "<string>",
"is_noteworthy": true,
"has_presentable_calculations": true,
"largest_apex_delta": 0,
"options": [
{
"display": "<string>",
"value": "<string>",
"apex_score": 0,
"content": "<string>",
"sample_size": -1,
"option_display_order": 1073741824
}
],
"name": "<string>"
}
],
"is_primary": true,
"name": "<string>"
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
A UUID string identifying this report.
Query Parameters
Optional configuration id to retrieve. If not provided, the primary configuration will be used.
⌘I
Observations
curl --request GET \
--url https://api.main.apexscore.ai/api/v1/reports/{id}/observations/ \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.main.apexscore.ai/api/v1/reports/{id}/observations/"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.main.apexscore.ai/api/v1/reports/{id}/observations/', 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.main.apexscore.ai/api/v1/reports/{id}/observations/",
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.main.apexscore.ai/api/v1/reports/{id}/observations/"
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.main.apexscore.ai/api/v1/reports/{id}/observations/")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.main.apexscore.ai/api/v1/reports/{id}/observations/")
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{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"dataset": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configuration": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"result": {
"state": {
"status_message": "<string>",
"observations_data_pending": "<string>",
"text_analysis_data_pending": "<string>"
}
},
"filterables": [
{
"content": "<string>",
"is_noteworthy": true,
"has_presentable_calculations": true,
"largest_apex_delta": 0,
"options": [
{
"display": "<string>",
"value": "<string>",
"apex_score": 0,
"content": "<string>",
"sample_size": -1,
"option_display_order": 1073741824
}
],
"name": "<string>"
}
],
"is_primary": true,
"name": "<string>"
}
}
}