Share of Voice Over Time
curl --request POST \
--url https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"end_date": "2024-01-31T23:59:59.999Z",
"location_ids": [
"123e4567-e89b-12d3-a456-426614174111"
]
}
}
'import requests
url = "https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series"
payload = {
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"end_date": "2024-01-31T23:59:59.999Z",
"location_ids": ["123e4567-e89b-12d3-a456-426614174111"]
}
}
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({
website_id: '123e4567-e89b-12d3-a456-426614174000',
filters: {
start_date: '2024-01-01T00:00:00.000Z',
end_date: '2024-01-31T23:59:59.999Z',
location_ids: ['123e4567-e89b-12d3-a456-426614174111']
}
})
};
fetch('https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series', 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/metrics/share-of-voice/time-series",
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([
'website_id' => '123e4567-e89b-12d3-a456-426614174000',
'filters' => [
'start_date' => '2024-01-01T00:00:00.000Z',
'end_date' => '2024-01-31T23:59:59.999Z',
'location_ids' => [
'123e4567-e89b-12d3-a456-426614174111'
]
]
]),
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.athenahq.ai/api/v1/metrics/share-of-voice/time-series"
payload := strings.NewReader("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\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.athenahq.ai/api/v1/metrics/share-of-voice/time-series")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series")
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 \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"date": "2024-06-15",
"Acme Corp": {
"value": 33.3,
"relative_mention_rate": 40,
"is_self": true
},
"Competitor Inc": {
"value": 26.7,
"relative_mention_rate": 32,
"is_self": false
}
}
]
}Share of Voice
Share of Voice Over Time
Returns daily share of voice breakdown over the specified date range. Each entry contains the date and SOV percentages for your brand and competitors, plus each company’s relative_mention_rate: its mentions as a percentage of that day’s responses that mention at least one tracked brand.
POST
/
api
/
v1
/
metrics
/
share-of-voice
/
time-series
Share of Voice Over Time
curl --request POST \
--url https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"end_date": "2024-01-31T23:59:59.999Z",
"location_ids": [
"123e4567-e89b-12d3-a456-426614174111"
]
}
}
'import requests
url = "https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series"
payload = {
"website_id": "123e4567-e89b-12d3-a456-426614174000",
"filters": {
"start_date": "2024-01-01T00:00:00.000Z",
"end_date": "2024-01-31T23:59:59.999Z",
"location_ids": ["123e4567-e89b-12d3-a456-426614174111"]
}
}
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({
website_id: '123e4567-e89b-12d3-a456-426614174000',
filters: {
start_date: '2024-01-01T00:00:00.000Z',
end_date: '2024-01-31T23:59:59.999Z',
location_ids: ['123e4567-e89b-12d3-a456-426614174111']
}
})
};
fetch('https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series', 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/metrics/share-of-voice/time-series",
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([
'website_id' => '123e4567-e89b-12d3-a456-426614174000',
'filters' => [
'start_date' => '2024-01-01T00:00:00.000Z',
'end_date' => '2024-01-31T23:59:59.999Z',
'location_ids' => [
'123e4567-e89b-12d3-a456-426614174111'
]
]
]),
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.athenahq.ai/api/v1/metrics/share-of-voice/time-series"
payload := strings.NewReader("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\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.athenahq.ai/api/v1/metrics/share-of-voice/time-series")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/metrics/share-of-voice/time-series")
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 \"website_id\": \"123e4567-e89b-12d3-a456-426614174000\",\n \"filters\": {\n \"start_date\": \"2024-01-01T00:00:00.000Z\",\n \"end_date\": \"2024-01-31T23:59:59.999Z\",\n \"location_ids\": [\n \"123e4567-e89b-12d3-a456-426614174111\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"date": "2024-06-15",
"Acme Corp": {
"value": 33.3,
"relative_mention_rate": 40,
"is_self": true
},
"Competitor Inc": {
"value": 26.7,
"relative_mention_rate": 32,
"is_self": false
}
}
]
}Body
application/json
Request body for share of voice endpoints
Response
Successful response with time series data
Show child attributes
Show child attributes
Was this page helpful?
⌘I