Analyses

Create analysis

Create a brand perception analysis in a workspace and schedule its first collection.

Required: brand, category, exactly 3 competitors, one to 10 distinct country codes in countries (WW stands for Worldwide), and one to 8 distinct ids of active (neither archived nor deleted) persona records of this workspace in persona_ids: pick them with list_personas, or create them first with create_persona or generate_personas (free-text personas are ignored). Optional: up to 8 attributes to track; the distinct llm_providers to query, among those get_analysis_models returns for the organization (defaults to the standard set); the language of the prompts; collect_end_date, at least two weeks from today (omitted, the analysis keeps collecting until it is archived); is_boost, which runs four collections within 24 hours instead of one.

Creating consumes max(1, countries) × max(1, personas) slots of the workspace analysis quota (get_analysis_quota) and the credits returned by compute_analysis_cost. Check both, and show the user the setup and its cost, before calling this endpoint. Required permission: write:analysis.

POST

organizations

{organization_id}

workspaces

{workspace_id}

analyses

Create analysis

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countries": [],
  "brand": "<string>",
  "category": "<string>",
  "competitors": [
    "<string>"
  ],
  "persona_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "llm_providers": [],
  "name": "<string>",
  "personas": [
    "<string>"
  ],
  "attributes": [
    "<string>"
  ],
  "collect_end_date": "2023-12-25",
  "language": "en",
  "is_boost": false
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses"

payload = {
    "countries": [],
    "brand": "<string>",
    "category": "<string>",
    "competitors": ["<string>"],
    "persona_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "llm_providers": [],
    "name": "<string>",
    "personas": ["<string>"],
    "attributes": ["<string>"],
    "collect_end_date": "2023-12-25",
    "language": "en",
    "is_boost": False
}
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({
    countries: [],
    brand: '<string>',
    category: '<string>',
    competitors: ['<string>'],
    persona_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    llm_providers: [],
    name: '<string>',
    personas: ['<string>'],
    attributes: ['<string>'],
    collect_end_date: '2023-12-25',
    language: 'en',
    is_boost: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses', 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",
  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([
    'countries' => [
        
    ],
    'brand' => '<string>',
    'category' => '<string>',
    'competitors' => [
        '<string>'
    ],
    'persona_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'llm_providers' => [
        
    ],
    'name' => '<string>',
    'personas' => [
        '<string>'
    ],
    'attributes' => [
        '<string>'
    ],
    'collect_end_date' => '2023-12-25',
    'language' => 'en',
    'is_boost' => false
  ]),
  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"

	payload := strings.NewReader("{\n  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\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")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses")

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  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "brand": "<string>",
  "category": "<string>",
  "countries": [
    "<string>"
  ],
  "competitors": [
    "<string>"
  ],
  "personas": [
    "<string>"
  ],
  "persona_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "attributes": [
    "<string>"
  ],
  "is_archived": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "active_clustering": true,
  "collect_end_date": "2023-12-25",
  "llm_providers": [
    "<string>"
  ],
  "llm_provider_versions": "<unknown>",
  "language": "ar",
  "is_boost": true,
  "generation_cost": -1
}

Authorizations

Authorization

string

header

required

Path Parameters

organization_id

string<uuid>

required

A UUID string identifying the organization.

workspace_id

string<uuid>

required

A UUID string identifying the workspace.

Body

countries

enum<string>[]

required

Required array length: 1 - 10 elements

AE - AE
AR - AR
AT - AT
AU - AU
BE - BE
BH - BH
BO - BO
BR - BR
CA - CA
CH - CH
CL - CL
CN - CN
CO - CO
CR - CR
CZ - CZ
DE - DE
DK - DK
DO - DO
EC - EC
EG - EG
ES - ES
FI - FI
FR - FR
GB - GB
GQ - GQ
GR - GR
GT - GT
HK - HK
HU - HU
IE - IE
ID - ID
IL - IL
IN - IN
IQ - IQ
IT - IT
JP - JP
KR - KR
KW - KW
LU - LU
MA - MA
MX - MX
MY - MY
NG - NG
NL - NL
NO - NO
NZ - NZ
PA - PA
PE - PE
PH - PH
PK - PK
PL - PL
PT - PT
QA - QA
RO - RO
RU - RU
SA - SA
SE - SE
SG - SG
TH - TH
TR - TR
TW - TW
VN - VN
US - US
ZA - ZA
EU - EU
NA - NA
WW - WW

Available options:

AE,

AR,

AT,

AU,

BE,

BH,

BO,

BR,

CA,

CH,

CL,

CN,

CO,

CR,

CZ,

DE,

DK,

DO,

EC,

EG,

ES,

FI,

FR,

GB,

GQ,

GR,

GT,

HK,

HU,

IE,

ID,

IL,

IN,

IQ,

IT,

JP,

KR,

KW,

LU,

MA,

MX,

MY,

NG,

NL,

NO,

NZ,

PA,

PE,

PH,

PK,

PL,

PT,

QA,

RO,

RU,

SA,

SE,

SG,

TH,

TR,

TW,

VN,

US,

ZA,

EU,

NA,

WW

brand

string

required

Maximum string length: 255

Response

201 - application/json

string<uuid>

required

read-only

category

string

required

Maximum string length: 255

countries

string[]

Maximum string length: 255

competitors

string[]

Maximum string length: 255

personas

string[]

Maximum string length: 255

persona_ids

string<uuid>[]

attributes

string[]

Maximum string length: 255

is_archived

boolean

archived_at

string<date-time> | null

active_clustering

boolean

collect_end_date

string<date> | null

llm_providers

string[]

Maximum string length: 255

llm_provider_versions

any

language

enum<string>

ar - ar
da - da
de - de
en - en
es - es
eu - eu
fi - fi
fil - fil
fr - fr
he - he
hi - hi
hu - hu
id - id
it - it
ja - ja
ko - ko
nl - nl
no - no
pl - pl
pt - pt
ro - ro
sv - sv
th - th
tr - tr
ur - ur
vi - vi
zh - zh
zh-TW - zh TW
zh-HK - zh HK

Available options:

ar,

da,

de,

en,

es,

eu,

fi,

fil,

fr,

he,

hi,

hu,

id,

it,

ja,

ko,

nl,

no,

pl,

pt,

ro,

sv,

th,

tr,

ur,

vi,

zh,

zh-TW,

zh-HK,

is_boost

boolean

generation_cost

integer

Required range: -2147483648 <= x <= 2147483647

Create analysis

curl --request POST \
  --url https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "countries": [],
  "brand": "<string>",
  "category": "<string>",
  "competitors": [
    "<string>"
  ],
  "persona_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "llm_providers": [],
  "name": "<string>",
  "personas": [
    "<string>"
  ],
  "attributes": [
    "<string>"
  ],
  "collect_end_date": "2023-12-25",
  "language": "en",
  "is_boost": false
}
'

import requests

url = "https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses"

payload = {
    "countries": [],
    "brand": "<string>",
    "category": "<string>",
    "competitors": ["<string>"],
    "persona_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "llm_providers": [],
    "name": "<string>",
    "personas": ["<string>"],
    "attributes": ["<string>"],
    "collect_end_date": "2023-12-25",
    "language": "en",
    "is_boost": False
}
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({
    countries: [],
    brand: '<string>',
    category: '<string>',
    competitors: ['<string>'],
    persona_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    llm_providers: [],
    name: '<string>',
    personas: ['<string>'],
    attributes: ['<string>'],
    collect_end_date: '2023-12-25',
    language: 'en',
    is_boost: false
  })
};

fetch('https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses', 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",
  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([
    'countries' => [
        
    ],
    'brand' => '<string>',
    'category' => '<string>',
    'competitors' => [
        '<string>'
    ],
    'persona_ids' => [
        '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ],
    'llm_providers' => [
        
    ],
    'name' => '<string>',
    'personas' => [
        '<string>'
    ],
    'attributes' => [
        '<string>'
    ],
    'collect_end_date' => '2023-12-25',
    'language' => 'en',
    'is_boost' => false
  ]),
  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"

	payload := strings.NewReader("{\n  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\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")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofmodel.ai/v1/organizations/{organization_id}/workspaces/{workspace_id}/analyses")

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  \"countries\": [],\n  \"brand\": \"<string>\",\n  \"category\": \"<string>\",\n  \"competitors\": [\n    \"<string>\"\n  ],\n  \"persona_ids\": [\n    \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  ],\n  \"llm_providers\": [],\n  \"name\": \"<string>\",\n  \"personas\": [\n    \"<string>\"\n  ],\n  \"attributes\": [\n    \"<string>\"\n  ],\n  \"collect_end_date\": \"2023-12-25\",\n  \"language\": \"en\",\n  \"is_boost\": false\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "brand": "<string>",
  "category": "<string>",
  "countries": [
    "<string>"
  ],
  "competitors": [
    "<string>"
  ],
  "personas": [
    "<string>"
  ],
  "persona_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "attributes": [
    "<string>"
  ],
  "is_archived": true,
  "archived_at": "2023-11-07T05:31:56Z",
  "active_clustering": true,
  "collect_end_date": "2023-12-25",
  "llm_providers": [
    "<string>"
  ],
  "llm_provider_versions": "<unknown>",
  "language": "ar",
  "is_boost": true,
  "generation_cost": -1
}

Overview

Core API

Search API

Create analysis

Authorizations

Path Parameters

Body

Response