Mettre à jour le suivi
curl --request PATCH \
--url https://www.qwairy.co/api/v1/brands/{brandId}/monitoring \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"frequency": "<string>",
"analysisWeekDay": {},
"analysisMonthDay": {},
"autoGenerateAnswers": true,
"models": [
"<string>"
],
"dryRun": true
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/monitoring"
payload = {
"frequency": "<string>",
"analysisWeekDay": {},
"analysisMonthDay": {},
"autoGenerateAnswers": True,
"models": ["<string>"],
"dryRun": True
}
headers = {
"Authorization": "<authorization>",
"If-Match": "<if-match>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: '<authorization>',
'If-Match': '<if-match>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
frequency: '<string>',
analysisWeekDay: {},
analysisMonthDay: {},
autoGenerateAnswers: true,
models: ['<string>'],
dryRun: true
})
};
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));Marques
Mettre à jour le suivi
Modifiez le calendrier de suivi et les modèles d’un workspace, mettez le suivi en pause ou validez un changement avec dryRun avant de l’enregistrer avec l’ETag.
PATCH
https://www.qwairy.co
/
api
/
v1
/
brands
/
{brandId}
/
monitoring
Mettre à jour le suivi
curl --request PATCH \
--url https://www.qwairy.co/api/v1/brands/{brandId}/monitoring \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--header 'If-Match: <if-match>' \
--data '
{
"frequency": "<string>",
"analysisWeekDay": {},
"analysisMonthDay": {},
"autoGenerateAnswers": true,
"models": [
"<string>"
],
"dryRun": true
}
'import requests
url = "https://www.qwairy.co/api/v1/brands/{brandId}/monitoring"
payload = {
"frequency": "<string>",
"analysisWeekDay": {},
"analysisMonthDay": {},
"autoGenerateAnswers": True,
"models": ["<string>"],
"dryRun": True
}
headers = {
"Authorization": "<authorization>",
"If-Match": "<if-match>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: '<authorization>',
'If-Match': '<if-match>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
frequency: '<string>',
analysisWeekDay: {},
analysisMonthDay: {},
autoGenerateAnswers: true,
models: ['<string>'],
dryRun: true
})
};
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));Met à jour les réglages de suivi fournis. Lisez d’abord Obtenir le suivi et copiez son ETag. Lorsque le GET renvoie des valeurs par défaut calculées, l’ETag initial est
Fournissez au moins un champ modifiable. Passer à
Consultez Codes d’erreur pour les erreurs d’authentification, d’offre, d’idempotence et de serveur. Sur
"0" ; ce PATCH enregistre les premiers réglages. Les champs omis gardent les valeurs par défaut : aucun modèle et pas de réponses automatiques.
Nécessite une offre Business, Agency Business ou Enterprise active. Utilisez un jeton d’API dont l’accès en écriture est activé. Consultez Écrire des données pour l’idempotence, les requêtes conditionnelles et la gestion des erreurs.
NONE, DAILY, WEEKLY ou MONTHLY. NONE arrête le calendrier du workspace : les prompts qui en héritent s’arrêtent, ceux qui ont leur propre fréquence continuent, comme dans le dashboard.Jour de 1 à 7 pour le suivi hebdomadaire. Pour les premiers réglages enregistrés, une valeur omise ou null utilise le jour de la semaine en cours ; les mises à jour suivantes peuvent enregistrer null.
Jour de 1 à 28 pour le suivi mensuel. Pour les premiers réglages enregistrés, une valeur omise ou null utilise le jour 1 ; les mises à jour suivantes peuvent enregistrer null.
Liste de remplacement de 1 à 20 codes de modèles Qwairy activés. Lisez les codes actuellement sélectionnés avec GET. Les codes inconnus ou désactivés sont rejetés.
NONE conserve les réglages de suivi de chaque prompt. Le travail accepté avant le changement peut encore se terminer.
Réponse
Renvoie200, un nouvel ETag et un objet monitoring avec les mêmes champs que Obtenir le suivi. paused indique si frequency vaut NONE ; isDefault est faux une fois les réglages enregistrés.
Requête et réponse synthétiques
Cet exemple suppose que l’ETag actuel du suivi est"3".
curl -X PATCH "https://www.qwairy.co/api/v1/brands/$BRAND_ID/monitoring" \
-H "Authorization: Bearer $QWAIRY_API_TOKEN" \
-H 'If-Match: "3"' \
-H "Content-Type: application/json" \
-d '{"frequency":"NONE"}'
{
"monitoring": {
"brandId": "b1c2d3e4-0000-4000-8000-000000000000",
"frequency": "NONE",
"paused": true,
"analysisWeekDay": 1,
"analysisMonthDay": 1,
"autoGenerateAnswers": true,
"models": ["openai-gpt"],
"lastAnalysisDate": null,
"version": 4,
"isDefault": false
}
}
Erreurs
| Statut | Code | Cause |
|---|---|---|
| 400 | INVALID_REQUEST | Calendrier invalide ou sélection de modèles vide ou indisponible |
| 403 | INSUFFICIENT_PLAN | Un modèle sélectionné est un modèle premium non inclus dans votre offre |
| 404 | RESOURCE_NOT_FOUND | Workspace absent ou inaccessible |
| 412 | PRECONDITION_FAILED | Le suivi a changé depuis votre lecture |
| 428 | PRECONDITION_REQUIRED | If-Match est absent |
429, respectez Retry-After ; les écritures peuvent renvoyer 503 SERVICE_UNAVAILABLE si le limiteur d’écriture est indisponible.
