Lister les sources par domaine racine
curl --request POST \
--url https://api.athenahq.ai/api/v1/sources \
--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"
},
"page_size": 30,
"sort_field": "citation_percentage",
"sort_direction": "desc"
}
'import requests
url = "https://api.athenahq.ai/api/v1/sources"
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"
},
"page_size": 30,
"sort_field": "citation_percentage",
"sort_direction": "desc"
}
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'},
page_size: 30,
sort_field: 'citation_percentage',
sort_direction: 'desc'
})
};
fetch('https://api.athenahq.ai/api/v1/sources', 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/sources",
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'
],
'page_size' => 30,
'sort_field' => 'citation_percentage',
'sort_direction' => 'desc'
]),
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/sources"
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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\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/sources")
.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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/sources")
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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"sources": [
{
"root_domain": "wikipedia.org",
"total_mentions": 124,
"response_count": 86,
"estimated_impressions": 18400,
"domain_count": 31,
"mention_percentage": 12.3,
"citation_percentage": 14.1,
"competitor_mention_percentage": 3.2,
"brand_mention_percentage": 8.9,
"mentions_count": 47,
"responses_mentioned_count": 39,
"competitor_ids": [],
"default_source_type": "third_party",
"source_type_ids": [],
"first_seen": "2024-01-04"
}
],
"pagination": {
"page_num": 0,
"page_size": 30,
"total": 142
}
}Sources
Lister les sources par domaine racine
Renvoie les principales sources citées du site par domaine racine. Chaque ligne inclut citations, mentions, mentions de marque, impressions sur la période et default_source_type (owned / competitor / partner / third_party).
Complète POST /api/v1/source-pages, qui regroupe par URL, une ligne par page. Propriété et étiquettes suivent les règles centralisées de motifs d’URL. Les résumés de domaines ne considèrent que les règles d’hôte entier ; chemins et requêtes s’appliquent aux pages. Les hôtes www explicites restent distincts si leurs règles diffèrent de l’apex.
POST
/
api
/
v1
/
sources
Lister les sources par domaine racine
curl --request POST \
--url https://api.athenahq.ai/api/v1/sources \
--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"
},
"page_size": 30,
"sort_field": "citation_percentage",
"sort_direction": "desc"
}
'import requests
url = "https://api.athenahq.ai/api/v1/sources"
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"
},
"page_size": 30,
"sort_field": "citation_percentage",
"sort_direction": "desc"
}
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'},
page_size: 30,
sort_field: 'citation_percentage',
sort_direction: 'desc'
})
};
fetch('https://api.athenahq.ai/api/v1/sources', 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/sources",
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'
],
'page_size' => 30,
'sort_field' => 'citation_percentage',
'sort_direction' => 'desc'
]),
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/sources"
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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\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/sources")
.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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/sources")
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 },\n \"page_size\": 30,\n \"sort_field\": \"citation_percentage\",\n \"sort_direction\": \"desc\"\n}"
response = http.request(request)
puts response.read_body{
"sources": [
{
"root_domain": "wikipedia.org",
"total_mentions": 124,
"response_count": 86,
"estimated_impressions": 18400,
"domain_count": 31,
"mention_percentage": 12.3,
"citation_percentage": 14.1,
"competitor_mention_percentage": 3.2,
"brand_mention_percentage": 8.9,
"mentions_count": 47,
"responses_mentioned_count": 39,
"competitor_ids": [],
"default_source_type": "third_party",
"source_type_ids": [],
"first_seen": "2024-01-04"
}
],
"pagination": {
"page_num": 0,
"page_size": 30,
"total": 142
}
}Corps
application/json
Corps de liste des sources par domaine.
Site web dont répertorier les sources.
Exemple:
"123e4567-e89b-12d3-a456-426614174000"
Filtres pour interroger les réponses et les indicateurs. Transmettez les filtres d’emplacements dans le corps JSON comme filters.location_ids.
Show child attributes
Show child attributes
Numéro de page commençant à zéro.
Plage requise:
x >= 0Nombre de lignes par page (1 à 100).
Plage requise:
1 <= x <= 100Colonne selon laquelle trier.
Options disponibles:
citation_percentage, mention_percentage, competitor_mention_percentage, brand_mention_percentage, estimated_impressions, total_mentions, domain_count, mentions_count, root_domain, response_count, first_seen Options disponibles:
asc, desc Filtre de sous-chaîne sur normalized_root_domain. Protocole (https://), www., chemin, requête et fragment retirés : https://www.example.com/foo devient example.com.
Avec yes, compte uniquement les sources dont la réponse citante mentionne votre marque. Avec no, uniquement celles dont la réponse ne la mentionne PAS. Omettez le champ pour compter toutes les sources citées.
Options disponibles:
yes, no Avec yes, compte uniquement les sources dont la réponse citante mentionne votre marque. Avec no, uniquement celles dont la réponse ne la mentionne PAS. Omettez le champ pour compter toutes les sources citées.
Options disponibles:
yes, no Réponse
Réponse réussie avec la page de sources.
Show child attributes
Show child attributes
Métadonnées de pagination. Contrairement à Pagination (qui utilise une anticipation has_more), les vues de sources exposent un nombre total précis — la requête ClickHouse sous-jacente le calcule comme fonction de fenêtre dans le même parcours, sans coût d’aller-retour supplémentaire.
Show child attributes
Show child attributes
Cette page vous a-t-elle été utile ?