Clomni

Scope-lar və endpoint-lər: hesabatlar, CSAT, SLA

Son yeniləmə: 11 noyabr 2026 · 6 dəq oxunur

Hesabat rəqəmləri, müştəri məmnuniyyəti və SLA üçün scope-lar. Power BI, Looker Studio, Metabase kimi alətə rəqəm çəkmək üçün adətən reports:read kifayətdir. Hesabat endpoint-lərində vaxt Unix saniyəsi ilə verilir.

Addımlar

  1. 1

    Bu məqaləni necə oxumaq

    • Yollar https://api.clomni.ai/v1-dən sonra yazılır: GET /v1/agents tam ünvanda https://api.clomni.ai/v1/agents deməkdir. Yolda workspace ID yoxdur, çünki token bir workspace-ə bağlıdır.
    • Hər sorğuda Authorization: Bearer clomni_pat_xxx başlığı olur. Tokeni necə almaq: Developer API-də tokenlər və autentifikasiya.
    • Risk: aşağı (şəxsi məlumat yoxdur), orta (müştəri məlumatını oxuyur və ya daxili məlumatı dəyişir), yüksək (müştəriyə göndərir, silir, toplu çıxarır, canlı ayarı dəyişir).
    • Hər scope review-dan keçir, public app-da da. Ətraflı: Review: scope-ların yoxlanması və rədd səbəbləri.
    • «Əlavə verir»: write və manage eyni resursun read-ini də verir. send, delete, publish, assign, run heç nə vermir.
    • Endpoint bir neçə scope ilə açılırsa, onlardan biri kifayətdir. Scope çatmasa, API 403 insufficient_scope və cavabda required_scopes qaytarır.
    • Hər POST Idempotency-Key başlığı qəbul edir: təkrar sorğu ikinci dəfə icra olunmur.
  2. 2

    Hesabatları oxumaq (reports:read)

    Toplu rəqəmləri oxuyur: söhbət və mesaj sayı, ilk cavab və həll müddəti, operator, inbox, etiket, komanda və kanal üzrə yekunlar, canlı saylar, AI agent və bot göstəriciləri, hesabat hadisələri. Müştərinin şəxsi məlumatı yoxdur, ona görə aşağı riskdir. BI aləti üçün əsas scope budur.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/conversations/{conversation_id}/reporting_events: Söhbətin hesabat hadisələri
    • GET /v1/live_reports/conversation_metrics: Canlı söhbət sayları
    • GET /v1/live_reports/grouped_conversation_metrics: Operator və ya komanda üzrə canlı söhbət sayları
    • GET /v1/reporting_events: Hesabat hadisələri
    • GET /v1/reports: Hesabat zaman sırası
    • GET /v1/reports/agents: Operatorlar üzrə yekunlar
    • GET /v1/reports/bot_metrics: AI agent və bot göstəriciləri
    • GET /v1/reports/bot_summary: AI agent və bot yekunları
    • GET /v1/reports/conversation_traffic: Saat və həftə gününə görə söhbət axını
    • GET /v1/reports/conversations: Operatorlar üzrə açıq söhbət sayları
    • GET /v1/reports/conversations_summary: Söhbət xülasəsi
    • GET /v1/reports/first_response_time_distribution: İlk cavab müddətinin paylanması
    • GET /v1/reports/inbox_label_matrix: Inbox və etiket üzrə söhbət sayları
    • GET /v1/reports/inboxes: Inbox-lar üzrə yekunlar
    • GET /v1/reports/labels: Etiketlər üzrə yekunlar
    • GET /v1/reports/outgoing_messages_count: Gedən mesaj sayları
    • GET /v1/reports/summary: Hesabat yekunları
    • GET /v1/reports/teams: Komandalar üzrə yekunlar
    • GET /v1/summary_reports/agent: Operatorlar üzrə xülasə hesabatı
    • GET /v1/summary_reports/channel: Kanallar üzrə xülasə hesabatı
    • GET /v1/summary_reports/inbox: Inbox-lar üzrə xülasə hesabatı
    • GET /v1/summary_reports/label: Etiketlər üzrə xülasə hesabatı
    • GET /v1/summary_reports/team: Komandalar üzrə xülasə hesabatı

    Nümunə:

    curl "https://api.clomni.ai/v1/reports?metric=conversations_count&type=account&since=1793491200&until=1794096000&group_by=day&timezone_offset=4" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/live_reports/conversation_metrics" \
  -H "Authorization: Bearer clomni_pat_xxx"
  3. 3

    Məmnuniyyət cavablarını oxumaq (csat:read)

    Müştəri məmnuniyyəti (CSAT) cavablarını, şərhlərini və yekun paylanmanı oxuyur. Şərhlərdə müştərinin öz mətni olduğu üçün orta riskdir.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/csat_survey_responses: Məmnuniyyət cavabları
    • GET /v1/csat_survey_responses/metrics: Məmnuniyyət yekunları

    Nümunə:

    curl "https://api.clomni.ai/v1/csat_survey_responses?since=1793491200&until=1794096000&page=1" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/csat_survey_responses/metrics" \
  -H "Authorization: Bearer clomni_pat_xxx"
  4. 4

    SLA-nı görmək (sla:read)

    SLA qaydalarını və söhbətlər üzrə SLA nəticələrini, o cümlədən pozuntuları oxuyur.

    • Risk: aşağı.
    • Yoxlama: review-dan keçir, aşağı riskli scope-lara tez baxılır.
    • Əlavə verir: başqa scope vermir.

    Endpoint-lər:

    • GET /v1/applied_slas: Söhbətlər üzrə SLA nəticələri
    • GET /v1/applied_slas/metrics: SLA yekunları
    • GET /v1/sla_policies: SLA qaydası siyahısı
    • GET /v1/sla_policies/{sla_policy_id}: SLA qaydasını oxumaq

    Nümunə:

    curl "https://api.clomni.ai/v1/sla_policies" \
  -H "Authorization: Bearer clomni_pat_xxx"
    curl "https://api.clomni.ai/v1/applied_slas" \
  -H "Authorization: Bearer clomni_pat_xxx"
  5. 5

    SLA qaydalarını dəyişmək (sla:write)

    SLA qaydası yaradır, dəyişir və silir: ilk cavab, növbəti cavab və həll müddəti, yalnız iş saatlarında sayılsın ya yox.

    • Risk: orta.
    • Yoxlama: review-dan keçir. Bu icazə ilə hansı məlumatı, nə vaxt və nə üçün işlədəcəyinizi konkret yazın.
    • Əlavə verir: sla:read də verir.

    Endpoint-lər:

    • POST /v1/sla_policies: SLA qaydası yaratmaq
    • PATCH /v1/sla_policies/{sla_policy_id}: SLA qaydasını yeniləmək
    • DELETE /v1/sla_policies/{sla_policy_id}: SLA qaydasını silmək

    Nümunə:

    curl -X POST "https://api.clomni.ai/v1/sla_policies" \
  -H "Authorization: Bearer clomni_pat_xxx" \
  -H "Content-Type: application/json" \
  -d '{"name": "Standart", "first_response_time_threshold": 900, "resolution_time_threshold": 28800, "only_during_business_hours": true}'
  6. 6

    Əlaqəli məqalələr

Sənəd

Developer platforması: bələdçi v1.0 · 41 səhifə Aç Endir