Obter um monitor
Leia a definição de um monitor com o detalhe do período que a visão geral do painel mostra.
GET
/
v1
/
monitors
/
{id}
Get monitor (legacy detail)
curl --request GET \
--url https://api.querying.ai/v1/monitors/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.querying.ai/v1/monitors/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.querying.ai/v1/monitors/{id}', 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.querying.ai/v1/monitors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.querying.ai/v1/monitors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.querying.ai/v1/monitors/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.querying.ai/v1/monitors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"monitor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"mode": "BRAND",
"category": "<string>",
"promptTopics": {},
"engines": [
"CHATGPT"
],
"prompts": [
"<string>"
],
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"country": "<string>",
"intervalHours": 84,
"enabled": true,
"alertBelowPct": 50,
"competitors": [
{
"name": "<string>",
"aliases": [
"<string>"
],
"source": "user",
"domain": "<string>"
}
],
"competitorsReadAt": "2023-11-07T05:31:56Z",
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRunAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"location": {
"latitude": 37.4979,
"longitude": 127.0276
},
"grid": {
"center": {
"latitude": 37.4979,
"longitude": 127.0276
},
"size": 3,
"radiusMeters": 25050
},
"engineSettings": {
"CHATGPT": {
"samples": 5
},
"GOOGLE": {
"intervalHours": 168
}
},
"webhookUrl": "<string>",
"analysis": true
},
"stats": {
"runs": 123,
"mentioned": 123,
"cited": 123
},
"previous": {
"runs": 123,
"mentioned": 123,
"cited": 123
},
"engineRates": [
{
"runs": 123,
"mentioned": 123,
"cited": 123
}
],
"topDomains": [
{
"domain": "<string>",
"citations": 123,
"prompts": 123,
"own": true
}
],
"topPages": [
{
"url": "<string>",
"domain": "<string>",
"label": "<string>",
"citations": 123,
"prompts": 123,
"own": true
}
],
"shareOfVoice": {
"runs": 123,
"brands": [
{
"name": "<string>",
"mentions": 123
}
]
},
"voiceSeries": [
{
"day": "2023-11-07T05:31:56Z",
"name": "<string>",
"mentions": 123
}
],
"health": {
"completed": 123,
"failed": 123,
"pending": 123,
"topError": "<string>"
},
"series": [
{
"day": "2023-11-07T05:31:56Z",
"engine": "CHATGPT",
"runs": 123,
"mentioned": 123,
"cited": 123
}
],
"cells": [
{
"prompt": "<string>",
"engine": "CHATGPT",
"mentioned": true,
"cited": true,
"position": 123,
"ranAt": "2023-11-07T05:31:56Z",
"taskId": "<string>"
}
],
"windowDays": 7
}
}
Autorizações
Your API key, sent as Authorization: Bearer <key>.
Parâmetros de caminho
Monitor id from GET /v1/monitors.
Parâmetros de consulta
Window length ending now. Only these three values are accepted.
Opções disponíveis:
7, 30, 90 Resposta
Monitor, window aggregates, all-time latest cells and recent task health.
Legacy period detail. stats, previous, engineRates, series, shareOfVoice and voiceSeries share the window from days; cells is all-time and unfiltered; topDomains and topPages are capped at 12 and 20 rows with no cursor. shareOfVoice here is the original answer-penetration view: each brand's mentions are counted against the answers collected, so the numbers can add up to more than 100. Use GET /v1/monitors/{id}/analytics for the report contract with the true share denominator.
⌘I
Get monitor (legacy detail)
curl --request GET \
--url https://api.querying.ai/v1/monitors/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.querying.ai/v1/monitors/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.querying.ai/v1/monitors/{id}', 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.querying.ai/v1/monitors/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.querying.ai/v1/monitors/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.querying.ai/v1/monitors/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.querying.ai/v1/monitors/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"monitor": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"mode": "BRAND",
"category": "<string>",
"promptTopics": {},
"engines": [
"CHATGPT"
],
"prompts": [
"<string>"
],
"aliases": [
"<string>"
],
"domains": [
"<string>"
],
"country": "<string>",
"intervalHours": 84,
"enabled": true,
"alertBelowPct": 50,
"competitors": [
{
"name": "<string>",
"aliases": [
"<string>"
],
"source": "user",
"domain": "<string>"
}
],
"competitorsReadAt": "2023-11-07T05:31:56Z",
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRunAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"location": {
"latitude": 37.4979,
"longitude": 127.0276
},
"grid": {
"center": {
"latitude": 37.4979,
"longitude": 127.0276
},
"size": 3,
"radiusMeters": 25050
},
"engineSettings": {
"CHATGPT": {
"samples": 5
},
"GOOGLE": {
"intervalHours": 168
}
},
"webhookUrl": "<string>",
"analysis": true
},
"stats": {
"runs": 123,
"mentioned": 123,
"cited": 123
},
"previous": {
"runs": 123,
"mentioned": 123,
"cited": 123
},
"engineRates": [
{
"runs": 123,
"mentioned": 123,
"cited": 123
}
],
"topDomains": [
{
"domain": "<string>",
"citations": 123,
"prompts": 123,
"own": true
}
],
"topPages": [
{
"url": "<string>",
"domain": "<string>",
"label": "<string>",
"citations": 123,
"prompts": 123,
"own": true
}
],
"shareOfVoice": {
"runs": 123,
"brands": [
{
"name": "<string>",
"mentions": 123
}
]
},
"voiceSeries": [
{
"day": "2023-11-07T05:31:56Z",
"name": "<string>",
"mentions": 123
}
],
"health": {
"completed": 123,
"failed": 123,
"pending": 123,
"topError": "<string>"
},
"series": [
{
"day": "2023-11-07T05:31:56Z",
"engine": "CHATGPT",
"runs": 123,
"mentioned": 123,
"cited": 123
}
],
"cells": [
{
"prompt": "<string>",
"engine": "CHATGPT",
"mentioned": true,
"cited": true,
"position": 123,
"ranAt": "2023-11-07T05:31:56Z",
"taskId": "<string>"
}
],
"windowDays": 7
}
}