Genel rapor özeti
GET/api/v1/reports/overview
Bu ayın mesaj ve AI kullanımı (organizasyon geneli), kişi, izinli ve devredilen sohbet sayıları; seçili dönemin bot, saat ve gün dağılımı; kampanya özeti. Üye rolü yalnız erişebildiği botların verisini görür. Kapsam: reports:read.
- Kapsam
reports:read- SDK metodu
- getReportOverview · get_report_overview
- MCP aracı
getReportOverviewsalt okunur
Parametreler
| Ad | Tür | Zorunlu | Açıklama |
|---|---|---|---|
dayssorgu | enum | hayır | Dönem (gün): 7, 30 ya da 90; varsayılan 307 | 30 | 90, default 30 |
Örnek istek
curl -X GET "https://hiboty.com/api/v1/reports/overview" \
-H "Authorization: Bearer $HIBOTY_API_KEY"Örnek yanıt (200)
{
"data": {
"days": 1,
"usage": {
"messages": {
"used": 1,
"limit": 1
},
"ai_replies": {
"used": 1,
"limit": 1,
"effective_limit": 1,
"own_key": true
},
"ai_tokens": 1
},
"contacts": {
"total": 1,
"opted_in": 1
},
"conversations": {
"total": 1,
"handoff": 1
},
"bots": [
{
"name": "Hiboty",
"incoming": 1,
"ai": 1,
"agent": 1
}
],
"hourly": [
1
],
"daily": [
{
"date": "string",
"ai": 1,
"agent": 1
}
],
"campaigns": {
"total": 1,
"completed": 1,
"delivered": 1
}
}
}Olası hatalar
400Geçersiz istek: eksik ya da hatalı alan, bilinmeyen alan adı (validation_error).401API anahtarı yok, geçersiz ya da iptal edilmiş (unauthorized).403Kapsam yok (scope), plan izin vermiyor (plan_limit), rol yetmiyor (forbidden_role), e-posta doğrulanmamış (email_not_verified) ya da organizasyon askıda.429Anahtar, kullanıcı ya da organizasyon istek sınırı (X-RateLimit-Scope) veya aylık mesaj kotası aşıldı; Retry-After başlığına uyun.