Get monitoring
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/monitoring \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/monitoring"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/monitoring', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Brands
Get monitoring
Read the effective monitoring schedule of a workspace, its selected models and the ETag you need to update them. Defaults are returned when nothing is saved.
GET
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
monitoring
Get monitoring
curl --request GET \
--url https://www.qwairy.co/api/v1/brands/{brandId}/monitoring \
--header 'Authorization: <authorization>'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/monitoring"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://www.qwairy.co/api/v1/brands/{brandId}/monitoring', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));Reads monitoring settings. When none have been saved, the endpoint returns
computed defaults with
Copy the ETag to Update monitoring
to change the schedule or pause it.
isDefault: true and ETag "0", without persisting
anything. As in the dashboard, these defaults select no model and do not
generate answers automatically, so nothing runs or uses credits until models
are chosen. Read access is available from Growth and Agency Growth.
Response
Returns200 with success: true, monitoring, ETag and
Cache-Control: private, no-store.
| Monitoring field | Meaning |
|---|---|
brandId | Workspace identifier |
frequency | NONE, DAILY, WEEKLY or MONTHLY |
paused | True when frequency is NONE. Prompts with their own frequency keep running |
analysisWeekDay | Weekly day from 1 to 7, or null |
analysisMonthDay | Monthly day from 1 to 28, or null |
autoGenerateAnswers | Whether scheduled analysis generates answers |
models | Selected Qwairy model codes; empty until models are chosen |
lastAnalysisDate | ISO 8601 timestamp, or null |
version | Value used to construct the returned ETag |
isDefault | Whether settings are computed defaults |
Synthetic request and response
curl -i "https://www.qwairy.co/api/v1/brands/$BRAND_ID/monitoring" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN"
{
"success":true,
"monitoring":{
"brandId":"b1c2d3e4-0000-4000-8000-000000000000",
"frequency":"WEEKLY",
"paused":false,
"analysisWeekDay":1,
"analysisMonthDay":1,
"autoGenerateAnswers":false,
"models":[],
"lastAnalysisDate":null,
"version":0,
"isDefault":true
}
}
Errors
An inaccessible workspace returns404 BRAND_NOT_FOUND.
See Error codes and honor Retry-After on 429.
