Get AI Search Value

curl --request GET \
  --url https://api.athenahq.ai/api/v1/ai-search-value \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.athenahq.ai/api/v1/ai-search-value', 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.athenahq.ai/api/v1/ai-search-value",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.athenahq.ai/api/v1/ai-search-value"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/ai-search-value")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "assumptions_version": "<string>",
  "computed_at": "<string>",
  "has_computed_valuations": true,
  "is_stale_value": true,
  "market": {
    "value_usd_mo": 123,
    "topics_priced": 123,
    "topics_total": 123,
    "coverage_pct": 123,
    "current_sov_pct": 123
  },
  "captured": {
    "conservative": 123,
    "expected": 123,
    "upside": 123
  },
  "headroom": {
    "conservative": 123,
    "expected": 123,
    "upside": 123
  },
  "measured_responses": 123,
  "topics": [
    {
      "topic_id": "<string>",
      "category": "<string>",
      "local_intent": true,
      "share_basis": "<string>",
      "pw_sov_pct": 123,
      "mix_adjusted_share_pct": 123,
      "mention_rate_pct": 123,
      "drift_pp": 123,
      "standard_error_pp": 123,
      "responses_28d": 123,
      "models_measured": 123,
      "personas_measured": 123,
      "locations_measured": 123,
      "captured": {
        "conservative": 123,
        "expected": 123,
        "upside": 123
      },
      "headroom": {
        "conservative": 123,
        "expected": 123,
        "upside": 123
      },
      "counted_in_total": true
    }
  ],
  "merge_suggestions": [
    {
      "topic_id_a": "<string>",
      "topic_id_b": "<string>",
      "name_a": "<string>",
      "name_b": "<string>",
      "similarity": 123
    }
  ],
  "contribution": {
    "modeled_attributed": {
      "conservative": 123,
      "expected": 123,
      "upside": 123
    },
    "attributed_share": 123,
    "attribution_unavailable": true
  },
  "forecast": {
    "id": "<string>",
    "created_at": "<string>",
    "days_elapsed": 123,
    "share_delta_pp": 123,
    "share_vs_do_nothing_pp": 123,
    "captured_delta_expected": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

api

ai-search-value

Get AI Search Value

curl --request GET \
  --url https://api.athenahq.ai/api/v1/ai-search-value \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.athenahq.ai/api/v1/ai-search-value', 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.athenahq.ai/api/v1/ai-search-value",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://api.athenahq.ai/api/v1/ai-search-value"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.athenahq.ai/api/v1/ai-search-value")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "assumptions_version": "<string>",
  "computed_at": "<string>",
  "has_computed_valuations": true,
  "is_stale_value": true,
  "market": {
    "value_usd_mo": 123,
    "topics_priced": 123,
    "topics_total": 123,
    "coverage_pct": 123,
    "current_sov_pct": 123
  },
  "captured": {
    "conservative": 123,
    "expected": 123,
    "upside": 123
  },
  "headroom": {
    "conservative": 123,
    "expected": 123,
    "upside": 123
  },
  "measured_responses": 123,
  "topics": [
    {
      "topic_id": "<string>",
      "category": "<string>",
      "local_intent": true,
      "share_basis": "<string>",
      "pw_sov_pct": 123,
      "mix_adjusted_share_pct": 123,
      "mention_rate_pct": 123,
      "drift_pp": 123,
      "standard_error_pp": 123,
      "responses_28d": 123,
      "models_measured": 123,
      "personas_measured": 123,
      "locations_measured": 123,
      "captured": {
        "conservative": 123,
        "expected": 123,
        "upside": 123
      },
      "headroom": {
        "conservative": 123,
        "expected": 123,
        "upside": 123
      },
      "counted_in_total": true
    }
  ],
  "merge_suggestions": [
    {
      "topic_id_a": "<string>",
      "topic_id_b": "<string>",
      "name_a": "<string>",
      "name_b": "<string>",
      "similarity": 123
    }
  ],
  "contribution": {
    "modeled_attributed": {
      "conservative": 123,
      "expected": 123,
      "upside": 123
    },
    "attributed_share": 123,
    "attribution_unavailable": true
  },
  "forecast": {
    "id": "<string>",
    "created_at": "<string>",
    "days_elapsed": 123,
    "share_delta_pp": 123,
    "share_vs_do_nothing_pp": 123,
    "captured_delta_expected": 123
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

x-api-key

string

header

required

API key for authentication. You can create one here.

Query Parameters

website_id

string

required

Response

Success

assumptions_version

string | null

required

computed_at

string | null

required

has_computed_valuations

boolean

required

is_stale_value

boolean

required

market

object

required

Show child attributes

captured

object

required

Show child attributes

headroom

object

required

Show child attributes

measured_responses

number

required

topics

object[]

required

Show child attributes

merge_suggestions

object[]

required

Show child attributes

contribution

object

required

Show child attributes

forecast

object | null

required

Show child attributes

Overview

Integrations

Core Resources

Analytics

Content & Knowledge

Administration

Get AI Search Value

Authorizations

Query Parameters

Response