Create analysis baseline report
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"images_bytes": {
"average_position_mention_rate_persona_1_image": 82828282,
"share_of_voice_model_image_persona_1": 82828282,
"perceived_strenghts_cluster_persona_1_image": 82828282,
"all_perceived_strenght_persona_1_image": 82828282,
"strenghts_by_llm_persona_1_image": 82828282,
"strenght_1_persona_1_image": 82828282,
"strenght_2_persona_1_image": 82828282,
"strenght_3_persona_1_image": 82828282,
"strenght_4_persona_1_image": 82828282,
"weakness_1_persona_1_image": 82828282,
"weakness_2_persona_1_image": 82828282,
"weakness_3_persona_1_image": 82828282,
"weakness_4_persona_1_image": 82828282,
"perceived_weaknesses_cluster_persona_1_image": 82828282,
"all_perceived_weakness_persona_1_image": 82828282,
"weaknesses_by_llm_persona_1_image": 82828282,
"attribute_evaluation_brand_persona_1_table": 82828282,
"attribute_evaluation_brand_persona_1_image": 82828282,
"sources_global_image": 82828282
}
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports"
payload = { "images_bytes": {
"average_position_mention_rate_persona_1_image": 82828282,
"share_of_voice_model_image_persona_1": 82828282,
"perceived_strenghts_cluster_persona_1_image": 82828282,
"all_perceived_strenght_persona_1_image": 82828282,
"strenghts_by_llm_persona_1_image": 82828282,
"strenght_1_persona_1_image": 82828282,
"strenght_2_persona_1_image": 82828282,
"strenght_3_persona_1_image": 82828282,
"strenght_4_persona_1_image": 82828282,
"weakness_1_persona_1_image": 82828282,
"weakness_2_persona_1_image": 82828282,
"weakness_3_persona_1_image": 82828282,
"weakness_4_persona_1_image": 82828282,
"perceived_weaknesses_cluster_persona_1_image": 82828282,
"all_perceived_weakness_persona_1_image": 82828282,
"weaknesses_by_llm_persona_1_image": 82828282,
"attribute_evaluation_brand_persona_1_table": 82828282,
"attribute_evaluation_brand_persona_1_image": 82828282,
"sources_global_image": 82828282
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
images_bytes: {
average_position_mention_rate_persona_1_image: 82828282,
share_of_voice_model_image_persona_1: 82828282,
perceived_strenghts_cluster_persona_1_image: 82828282,
all_perceived_strenght_persona_1_image: 82828282,
strenghts_by_llm_persona_1_image: 82828282,
strenght_1_persona_1_image: 82828282,
strenght_2_persona_1_image: 82828282,
strenght_3_persona_1_image: 82828282,
strenght_4_persona_1_image: 82828282,
weakness_1_persona_1_image: 82828282,
weakness_2_persona_1_image: 82828282,
weakness_3_persona_1_image: 82828282,
weakness_4_persona_1_image: 82828282,
perceived_weaknesses_cluster_persona_1_image: 82828282,
all_perceived_weakness_persona_1_image: 82828282,
weaknesses_by_llm_persona_1_image: 82828282,
attribute_evaluation_brand_persona_1_table: 82828282,
attribute_evaluation_brand_persona_1_image: 82828282,
sources_global_image: 82828282
}
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports",
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([
'images_bytes' => [
'average_position_mention_rate_persona_1_image' => 82828282,
'share_of_voice_model_image_persona_1' => 82828282,
'perceived_strenghts_cluster_persona_1_image' => 82828282,
'all_perceived_strenght_persona_1_image' => 82828282,
'strenghts_by_llm_persona_1_image' => 82828282,
'strenght_1_persona_1_image' => 82828282,
'strenght_2_persona_1_image' => 82828282,
'strenght_3_persona_1_image' => 82828282,
'strenght_4_persona_1_image' => 82828282,
'weakness_1_persona_1_image' => 82828282,
'weakness_2_persona_1_image' => 82828282,
'weakness_3_persona_1_image' => 82828282,
'weakness_4_persona_1_image' => 82828282,
'perceived_weaknesses_cluster_persona_1_image' => 82828282,
'all_perceived_weakness_persona_1_image' => 82828282,
'weaknesses_by_llm_persona_1_image' => 82828282,
'attribute_evaluation_brand_persona_1_table' => 82828282,
'attribute_evaluation_brand_persona_1_image' => 82828282,
'sources_global_image' => 82828282
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports"
payload := strings.NewReader("{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "df2a3b6d-4f5c-47d2-92d4-8b17db3b9159",
"analysis": "f41bcbf1-8f7a-46c1-baf3-18c9d1ff1234",
"search_project_id": null,
"status": "PENDING",
"url": null,
"created_by": "e3c7a801-badf-45f2-9113-66a5e1239abc"
}Analyses
Create analysis baseline report
Creates a new baseline report entry and triggers background generation via Prefect. This endpoint returns immediately with the created record in PENDING status. The actual Google Slides report will be populated asynchronously.
POST
/
v1
/
organizations
/
{organization_id}
/
workspaces
/
{workspace_id}
/
analyses
/
{analysis_id}
/
reports
Create analysis baseline report
curl --request POST \
--url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"images_bytes": {
"average_position_mention_rate_persona_1_image": 82828282,
"share_of_voice_model_image_persona_1": 82828282,
"perceived_strenghts_cluster_persona_1_image": 82828282,
"all_perceived_strenght_persona_1_image": 82828282,
"strenghts_by_llm_persona_1_image": 82828282,
"strenght_1_persona_1_image": 82828282,
"strenght_2_persona_1_image": 82828282,
"strenght_3_persona_1_image": 82828282,
"strenght_4_persona_1_image": 82828282,
"weakness_1_persona_1_image": 82828282,
"weakness_2_persona_1_image": 82828282,
"weakness_3_persona_1_image": 82828282,
"weakness_4_persona_1_image": 82828282,
"perceived_weaknesses_cluster_persona_1_image": 82828282,
"all_perceived_weakness_persona_1_image": 82828282,
"weaknesses_by_llm_persona_1_image": 82828282,
"attribute_evaluation_brand_persona_1_table": 82828282,
"attribute_evaluation_brand_persona_1_image": 82828282,
"sources_global_image": 82828282
}
}
'import requests
url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports"
payload = { "images_bytes": {
"average_position_mention_rate_persona_1_image": 82828282,
"share_of_voice_model_image_persona_1": 82828282,
"perceived_strenghts_cluster_persona_1_image": 82828282,
"all_perceived_strenght_persona_1_image": 82828282,
"strenghts_by_llm_persona_1_image": 82828282,
"strenght_1_persona_1_image": 82828282,
"strenght_2_persona_1_image": 82828282,
"strenght_3_persona_1_image": 82828282,
"strenght_4_persona_1_image": 82828282,
"weakness_1_persona_1_image": 82828282,
"weakness_2_persona_1_image": 82828282,
"weakness_3_persona_1_image": 82828282,
"weakness_4_persona_1_image": 82828282,
"perceived_weaknesses_cluster_persona_1_image": 82828282,
"all_perceived_weakness_persona_1_image": 82828282,
"weaknesses_by_llm_persona_1_image": 82828282,
"attribute_evaluation_brand_persona_1_table": 82828282,
"attribute_evaluation_brand_persona_1_image": 82828282,
"sources_global_image": 82828282
} }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
images_bytes: {
average_position_mention_rate_persona_1_image: 82828282,
share_of_voice_model_image_persona_1: 82828282,
perceived_strenghts_cluster_persona_1_image: 82828282,
all_perceived_strenght_persona_1_image: 82828282,
strenghts_by_llm_persona_1_image: 82828282,
strenght_1_persona_1_image: 82828282,
strenght_2_persona_1_image: 82828282,
strenght_3_persona_1_image: 82828282,
strenght_4_persona_1_image: 82828282,
weakness_1_persona_1_image: 82828282,
weakness_2_persona_1_image: 82828282,
weakness_3_persona_1_image: 82828282,
weakness_4_persona_1_image: 82828282,
perceived_weaknesses_cluster_persona_1_image: 82828282,
all_perceived_weakness_persona_1_image: 82828282,
weaknesses_by_llm_persona_1_image: 82828282,
attribute_evaluation_brand_persona_1_table: 82828282,
attribute_evaluation_brand_persona_1_image: 82828282,
sources_global_image: 82828282
}
})
};
fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports', 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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports",
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([
'images_bytes' => [
'average_position_mention_rate_persona_1_image' => 82828282,
'share_of_voice_model_image_persona_1' => 82828282,
'perceived_strenghts_cluster_persona_1_image' => 82828282,
'all_perceived_strenght_persona_1_image' => 82828282,
'strenghts_by_llm_persona_1_image' => 82828282,
'strenght_1_persona_1_image' => 82828282,
'strenght_2_persona_1_image' => 82828282,
'strenght_3_persona_1_image' => 82828282,
'strenght_4_persona_1_image' => 82828282,
'weakness_1_persona_1_image' => 82828282,
'weakness_2_persona_1_image' => 82828282,
'weakness_3_persona_1_image' => 82828282,
'weakness_4_persona_1_image' => 82828282,
'perceived_weaknesses_cluster_persona_1_image' => 82828282,
'all_perceived_weakness_persona_1_image' => 82828282,
'weaknesses_by_llm_persona_1_image' => 82828282,
'attribute_evaluation_brand_persona_1_table' => 82828282,
'attribute_evaluation_brand_persona_1_image' => 82828282,
'sources_global_image' => 82828282
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports"
payload := strings.NewReader("{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses/{analysis_id}/reports")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"images_bytes\": {\n \"average_position_mention_rate_persona_1_image\": 82828282,\n \"share_of_voice_model_image_persona_1\": 82828282,\n \"perceived_strenghts_cluster_persona_1_image\": 82828282,\n \"all_perceived_strenght_persona_1_image\": 82828282,\n \"strenghts_by_llm_persona_1_image\": 82828282,\n \"strenght_1_persona_1_image\": 82828282,\n \"strenght_2_persona_1_image\": 82828282,\n \"strenght_3_persona_1_image\": 82828282,\n \"strenght_4_persona_1_image\": 82828282,\n \"weakness_1_persona_1_image\": 82828282,\n \"weakness_2_persona_1_image\": 82828282,\n \"weakness_3_persona_1_image\": 82828282,\n \"weakness_4_persona_1_image\": 82828282,\n \"perceived_weaknesses_cluster_persona_1_image\": 82828282,\n \"all_perceived_weakness_persona_1_image\": 82828282,\n \"weaknesses_by_llm_persona_1_image\": 82828282,\n \"attribute_evaluation_brand_persona_1_table\": 82828282,\n \"attribute_evaluation_brand_persona_1_image\": 82828282,\n \"sources_global_image\": 82828282\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "df2a3b6d-4f5c-47d2-92d4-8b17db3b9159",
"analysis": "f41bcbf1-8f7a-46c1-baf3-18c9d1ff1234",
"search_project_id": null,
"status": "PENDING",
"url": null,
"created_by": "e3c7a801-badf-45f2-9113-66a5e1239abc"
}Authorizations
Path Parameters
A UUID string identifying the analysis.
A UUID string identifying the organization.
A UUID string identifying the workspace.
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data*/*
Response
201 - application/json
Successfully created a baseline report entry and triggered background generation.
Was this page helpful?
⌘I