curl --request POST \
--url https://api.peec.ai/customer/v1/agent-analytics/readiness/audits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"domains": [
"peec.ai"
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/agent-analytics/readiness/audits"
payload = {
"domains": ["peec.ai"],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({domains: ['peec.ai'], project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'})
};
fetch('https://api.peec.ai/customer/v1/agent-analytics/readiness/audits', 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.peec.ai/customer/v1/agent-analytics/readiness/audits",
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([
'domains' => [
'peec.ai'
],
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/agent-analytics/readiness/audits"
payload := strings.NewReader("{\n \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/agent-analytics/readiness/audits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/agent-analytics/readiness/audits")
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 \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"created": [
{
"domain": "peec.ai",
"run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b"
}
],
"skipped": [
{
"domain": "peec.ai",
"run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b",
"reason": "in_progress"
}
],
"rejected": [
{
"domain": "acme.com",
"reason": "not_own_domain",
"message": "<string>"
}
]
}{
"message": "<string>"
}Request Agent Readiness Audits
Queue Peec’s agent readiness audit for the project’s own brand domains. Audits run only on domains of the project’s own brands, matched exactly as the brand lists them; any other domain is returned in rejected and the rest of the request still goes through. A domain whose audit is already queued or running is returned in skipped with that run’s id instead of queuing a second one.
Audits run in the background. Follow each one with GET /agent-analytics/readiness, where the domain’s latest_run carries the same id and its status, and read the result there once it is completed.
curl --request POST \
--url https://api.peec.ai/customer/v1/agent-analytics/readiness/audits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"domains": [
"peec.ai"
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/agent-analytics/readiness/audits"
payload = {
"domains": ["peec.ai"],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({domains: ['peec.ai'], project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'})
};
fetch('https://api.peec.ai/customer/v1/agent-analytics/readiness/audits', 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.peec.ai/customer/v1/agent-analytics/readiness/audits",
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([
'domains' => [
'peec.ai'
],
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/agent-analytics/readiness/audits"
payload := strings.NewReader("{\n \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/agent-analytics/readiness/audits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/agent-analytics/readiness/audits")
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 \"domains\": [\n \"peec.ai\"\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"created": [
{
"domain": "peec.ai",
"run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b"
}
],
"skipped": [
{
"domain": "peec.ai",
"run_id": "0199c3a4-5b6e-7f80-9a1b-2c3d4e5f6a7b",
"reason": "in_progress"
}
],
"rejected": [
{
"domain": "acme.com",
"reason": "not_own_domain",
"message": "<string>"
}
]
}{
"message": "<string>"
}Authorizations
Body
Up to 50 of the project's own brand domains, exactly as GET /agent-analytics/readiness lists them in own.
1 - 50 elements1["peec.ai"]
Required if using a company api key
"or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
Response
Per-domain results
Per-domain results
Domains a new audit was queued for.
Show child attributes
Show child attributes
Domains with an audit already queued or running. No new audit is queued; run_id is the one in progress.
Show child attributes
Show child attributes
Domains not audited: not_own_domain for a domain that isn't one of the project's own brand domains, duplicate for a repeat within the request.
Show child attributes
Show child attributes
