Create Analysis

curl --request POST \
  --url https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "Nike",
  "brand_official_name": "Nike, Inc.",
  "category": "Running shoes",
  "country": "US",
  "frequency": "ONCE",
  "language": "en",
  "prompts": [
    {
      "funnel_stage": "MoFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "strength": "cushioning",
      "text": "best running shoes for daily training",
      "thematic": "Running shoes",
      "topic": "Daily trainers"
    },
    {
      "brand_type": "Brand",
      "funnel_stage": "ToFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "text": "are nike pegasus good for beginners",
      "thematic": "Running shoes",
      "topic": "Daily trainers"
    },
    {
      "funnel_stage": "MoFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "text": "best shoes for a first marathon",
      "thematic": "Running shoes",
      "topic": "Racing",
      "weakness": "price"
    }
  ],
  "sources": [
    "ChatGPT",
    "Gemini",
    "Perplexity"
  ],
  "website": "nike.com"
}
'

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses"

payload = {
    "brand": "Nike",
    "brand_official_name": "Nike, Inc.",
    "category": "Running shoes",
    "country": "US",
    "frequency": "ONCE",
    "language": "en",
    "prompts": [
        {
            "funnel_stage": "MoFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "strength": "cushioning",
            "text": "best running shoes for daily training",
            "thematic": "Running shoes",
            "topic": "Daily trainers"
        },
        {
            "brand_type": "Brand",
            "funnel_stage": "ToFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "text": "are nike pegasus good for beginners",
            "thematic": "Running shoes",
            "topic": "Daily trainers"
        },
        {
            "funnel_stage": "MoFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "text": "best shoes for a first marathon",
            "thematic": "Running shoes",
            "topic": "Racing",
            "weakness": "price"
        }
    ],
    "sources": ["ChatGPT", "Gemini", "Perplexity"],
    "website": "nike.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brand: 'Nike',
    brand_official_name: 'Nike, Inc.',
    category: 'Running shoes',
    country: 'US',
    frequency: 'ONCE',
    language: 'en',
    prompts: [
      {
        funnel_stage: 'MoFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        strength: 'cushioning',
        text: 'best running shoes for daily training',
        thematic: 'Running shoes',
        topic: 'Daily trainers'
      },
      {
        brand_type: 'Brand',
        funnel_stage: 'ToFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        text: 'are nike pegasus good for beginners',
        thematic: 'Running shoes',
        topic: 'Daily trainers'
      },
      {
        funnel_stage: 'MoFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        text: 'best shoes for a first marathon',
        thematic: 'Running shoes',
        topic: 'Racing',
        weakness: 'price'
      }
    ],
    sources: ['ChatGPT', 'Gemini', 'Perplexity'],
    website: 'nike.com'
  })
};

fetch('https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/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([
    'brand' => 'Nike',
    'brand_official_name' => 'Nike, Inc.',
    'category' => 'Running shoes',
    'country' => 'US',
    'frequency' => 'ONCE',
    'language' => 'en',
    'prompts' => [
        [
                'funnel_stage' => 'MoFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'strength' => 'cushioning',
                'text' => 'best running shoes for daily training',
                'thematic' => 'Running shoes',
                'topic' => 'Daily trainers'
        ],
        [
                'brand_type' => 'Brand',
                'funnel_stage' => 'ToFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'text' => 'are nike pegasus good for beginners',
                'thematic' => 'Running shoes',
                'topic' => 'Daily trainers'
        ],
        [
                'funnel_stage' => 'MoFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'text' => 'best shoes for a first marathon',
                'thematic' => 'Running shoes',
                'topic' => 'Racing',
                'weakness' => 'price'
        ]
    ],
    'sources' => [
        'ChatGPT',
        'Gemini',
        'Perplexity'
    ],
    'website' => 'nike.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses"

	payload := strings.NewReader("{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}"

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

{
  "id": "<string>",
  "internal_id": "<string>",
  "website": "<string>",
  "brand": "<string>",
  "status": "ACTIVE",
  "sources": [
    "Bing"
  ],
  "devices": [
    "DESKTOP"
  ],
  "country": "<string>",
  "language": "<string>",
  "frequency": "MONTHLY",
  "query_fanouts_enabled": true,
  "category": "<string>",
  "thematics": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "topics": []
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "brand_official_name": "<string>",
  "website_type": "DOMAIN",
  "personas": [],
  "related_products": [],
  "sub_brands": [],
  "perceptions": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Projects

Create Analysis

Create a Search analysis in the workspace: brand, website, engines, country and language, and the prompts, each naming its thematic, its topic and the persona of the workspace library asking it. The first collection starts right away and the workspace is debited one search credit per prompt. 402 when the workspace has fewer search credits than prompts; 422 when an engine is not in the references for this organization or when a persona id is unknown. Returns the analysis as GET /analyses/ does. Restricted to editors and above.

POST

organizations

{organization_id}

workspaces

{workspace_id}

analyses

Create Analysis

curl --request POST \
  --url https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand": "Nike",
  "brand_official_name": "Nike, Inc.",
  "category": "Running shoes",
  "country": "US",
  "frequency": "ONCE",
  "language": "en",
  "prompts": [
    {
      "funnel_stage": "MoFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "strength": "cushioning",
      "text": "best running shoes for daily training",
      "thematic": "Running shoes",
      "topic": "Daily trainers"
    },
    {
      "brand_type": "Brand",
      "funnel_stage": "ToFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "text": "are nike pegasus good for beginners",
      "thematic": "Running shoes",
      "topic": "Daily trainers"
    },
    {
      "funnel_stage": "MoFu",
      "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
      "text": "best shoes for a first marathon",
      "thematic": "Running shoes",
      "topic": "Racing",
      "weakness": "price"
    }
  ],
  "sources": [
    "ChatGPT",
    "Gemini",
    "Perplexity"
  ],
  "website": "nike.com"
}
'

import requests

url = "https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses"

payload = {
    "brand": "Nike",
    "brand_official_name": "Nike, Inc.",
    "category": "Running shoes",
    "country": "US",
    "frequency": "ONCE",
    "language": "en",
    "prompts": [
        {
            "funnel_stage": "MoFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "strength": "cushioning",
            "text": "best running shoes for daily training",
            "thematic": "Running shoes",
            "topic": "Daily trainers"
        },
        {
            "brand_type": "Brand",
            "funnel_stage": "ToFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "text": "are nike pegasus good for beginners",
            "thematic": "Running shoes",
            "topic": "Daily trainers"
        },
        {
            "funnel_stage": "MoFu",
            "persona_id": "4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f",
            "text": "best shoes for a first marathon",
            "thematic": "Running shoes",
            "topic": "Racing",
            "weakness": "price"
        }
    ],
    "sources": ["ChatGPT", "Gemini", "Perplexity"],
    "website": "nike.com"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    brand: 'Nike',
    brand_official_name: 'Nike, Inc.',
    category: 'Running shoes',
    country: 'US',
    frequency: 'ONCE',
    language: 'en',
    prompts: [
      {
        funnel_stage: 'MoFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        strength: 'cushioning',
        text: 'best running shoes for daily training',
        thematic: 'Running shoes',
        topic: 'Daily trainers'
      },
      {
        brand_type: 'Brand',
        funnel_stage: 'ToFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        text: 'are nike pegasus good for beginners',
        thematic: 'Running shoes',
        topic: 'Daily trainers'
      },
      {
        funnel_stage: 'MoFu',
        persona_id: '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
        text: 'best shoes for a first marathon',
        thematic: 'Running shoes',
        topic: 'Racing',
        weakness: 'price'
      }
    ],
    sources: ['ChatGPT', 'Gemini', 'Perplexity'],
    website: 'nike.com'
  })
};

fetch('https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/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([
    'brand' => 'Nike',
    'brand_official_name' => 'Nike, Inc.',
    'category' => 'Running shoes',
    'country' => 'US',
    'frequency' => 'ONCE',
    'language' => 'en',
    'prompts' => [
        [
                'funnel_stage' => 'MoFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'strength' => 'cushioning',
                'text' => 'best running shoes for daily training',
                'thematic' => 'Running shoes',
                'topic' => 'Daily trainers'
        ],
        [
                'brand_type' => 'Brand',
                'funnel_stage' => 'ToFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'text' => 'are nike pegasus good for beginners',
                'thematic' => 'Running shoes',
                'topic' => 'Daily trainers'
        ],
        [
                'funnel_stage' => 'MoFu',
                'persona_id' => '4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f',
                'text' => 'best shoes for a first marathon',
                'thematic' => 'Running shoes',
                'topic' => 'Racing',
                'weakness' => 'price'
        ]
    ],
    'sources' => [
        'ChatGPT',
        'Gemini',
        'Perplexity'
    ],
    'website' => 'nike.com'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses"

	payload := strings.NewReader("{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.shareofsearch.jplus.io/v1/organizations/{organization_id}/workspaces/{workspace_id}/search/analyses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brand\": \"Nike\",\n  \"brand_official_name\": \"Nike, Inc.\",\n  \"category\": \"Running shoes\",\n  \"country\": \"US\",\n  \"frequency\": \"ONCE\",\n  \"language\": \"en\",\n  \"prompts\": [\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"strength\": \"cushioning\",\n      \"text\": \"best running shoes for daily training\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"brand_type\": \"Brand\",\n      \"funnel_stage\": \"ToFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"are nike pegasus good for beginners\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Daily trainers\"\n    },\n    {\n      \"funnel_stage\": \"MoFu\",\n      \"persona_id\": \"4f2d9a6e-1b3c-4d5e-8f70-1a2b3c4d5e6f\",\n      \"text\": \"best shoes for a first marathon\",\n      \"thematic\": \"Running shoes\",\n      \"topic\": \"Racing\",\n      \"weakness\": \"price\"\n    }\n  ],\n  \"sources\": [\n    \"ChatGPT\",\n    \"Gemini\",\n    \"Perplexity\"\n  ],\n  \"website\": \"nike.com\"\n}"

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

{
  "id": "<string>",
  "internal_id": "<string>",
  "website": "<string>",
  "brand": "<string>",
  "status": "ACTIVE",
  "sources": [
    "Bing"
  ],
  "devices": [
    "DESKTOP"
  ],
  "country": "<string>",
  "language": "<string>",
  "frequency": "MONTHLY",
  "query_fanouts_enabled": true,
  "category": "<string>",
  "thematics": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "topics": []
    }
  ],
  "created_at": "<string>",
  "updated_at": "<string>",
  "workspace_id": "<string>",
  "name": "<string>",
  "brand_official_name": "<string>",
  "website_type": "DOMAIN",
  "personas": [],
  "related_products": [],
  "sub_brands": [],
  "perceptions": []
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

organization_id

string

required

workspace_id

string

required

Body

application/json

The body of POST /analyses: the setup an agent builds. The workspace is the path's, the thematics and topics come from the prompts, every id is generated, the device is desktop.

website

string

required

Website the analysis tracks, as a domain or subdomain (e.g. 'nike.com').

brand

string

required

Brand name to track, as users write it.

country

string

required

ISO 3166-1 alpha-2 country code of the collection (e.g. 'US').

language

string

required

Language code of the prompts (e.g. 'en'); the country-language pair must be one of the references.

sources

enum<string>[]

required

Engines to collect, by id as listed by the references (e.g. 'ChatGPT', 'Gemini'). At least one.

Available options:

Bing,

BingAIO,

ChatGPT,

Perplexity,

Google,

GoogleAIO,

GoogleAIMode,

Claude,

Gemini,

AmazonRufus,

Grok,

Copilot,

Mistral,

MuseSpark

prompts

PromptRequest · object[]

required

Prompts to collect, each naming its thematic, its topic and its persona. At least one. The thematics and topics are created from the distinct names, in order of first appearance.

Show child attributes

name

string | null

Display name of the analysis. Defaults to ' - '.

brand_official_name

string | null

Official or legal name of the brand when it differs from the display name.

Response

Successful Response

string

required

Unique identifier of the analysis.

internal_id

string

required

deprecated

UUID v4 unique identifier of the analysis.

website

string

required

Website being tracked by this analysis.

brand

string

required

Primary brand name associated with the tracked website.

status

enum<string>

required

Lifecycle status of the analysis.

Available options:

ACTIVE,

DELETED,

PAUSED

sources

enum<string>[]

required

Search engines and AI sources monitored by this analysis.

Available options:

Bing,

BingAIO,

ChatGPT,

Perplexity,

Google,

GoogleAIO,

GoogleAIMode,

Claude,

Gemini,

AmazonRufus,

Grok,

Copilot,

Mistral,

MuseSpark

devices

enum<string>[]

required

Device types for which results are collected.

Available options:

DESKTOP,

MOBILE,

TABLET

country

string

required

Country code for which search results are collected (ISO 3166-1 alpha-2).

language

string

required

Language code used for queries in this analysis (BCP 47).

frequency

enum<string>

required

How often data collection runs.

Available options:

MONTHLY,

WEEKLY,

DAILY,

ONCE

query_fanouts_enabled

boolean

required

Whether query fan-out (expanded query variants) is enabled for this analysis.

Overview

Core API

Search API

Create Analysis

Authorizations

Path Parameters

Body

Response