การดึงข้อมูลความเคลื่อนไหวล่าสุดของ Agent

การดึงข้อมูลความเคลื่อนไหวล่าสุดของ Agent

ดึงจำนวนเซสชันใหม่และคำถามของผู้ใช้ของ Agent หนึ่งหรือหลายตัวใน N นาทีล่าสุด เหมาะสำหรับการตรวจสอบความเคลื่อนไหวแบบตามเวลา สามารถสอบถาม Agent ได้สูงสุด 50 ตัวในครั้งเดียว

วิธีการร้องขอ

GET

ที่อยู่เรียกใช้งาน

https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity

การตรวจสอบสิทธิ์การเรียกใช้งาน

ใช้การยืนยันตัวตนแบบ Basic ด้วย DevKey / DevSecret ระดับบัญชี: Authorization: Basic ${BASIC_TOKEN} โดย ${BASIC_TOKEN} เป็นการเข้ารหัส Base64 ของ DevKey:DevSecret

  • บัญชีที่เรียกต้องเป็นสมาชิกขององค์กรที่สอดคล้องกับ org_id และมีสิทธิ์ "ดูการใช้งาน" (เจ้าขององค์กรหรือผู้ดูแลระบบจะได้สิทธิ์โดยอัตโนมัติ) พร้อมทั้งต้องสามารถเข้าดู Agent ดังกล่าว: ผู้สร้าง Agent, เจ้าขององค์กร หรือสมาชิกที่ได้รับสิทธิ์สำหรับ Agent นั้น (หรือทั้งหมด)
  • กรุณาเรียกใช้งานจากที่อยู่ของศูนย์ข้อมูลในองค์กร ${endpoint} โดยนำ region ที่ได้จาก รายการองค์กร มาใช้ (SG → sg, TH → th, JP → jp) หากเรียกจากศูนย์ข้อมูลอื่นจะได้ผลลัพธ์ว่า "ไม่ใช่สมาชิกขององค์กรนี้"

ความถี่การเรียกใช้งาน

  • DevKey แต่ละตัวเรียกใช้งาน API นี้ได้สูงสุด 60 ครั้งต่อ 1 นาที
  • ทุกครั้งที่เรียกจะถูกนับรวมในโควต้าต่อวินาทีของ "API ประเภทสถิติ" ของแพ็กเกจองค์กร และใช้ร่วมกับการเรียก API ประเภทสถิติด้วย Agent API Key
  • ผลลัพธ์การค้นหาจะถูกเก็บในแคช 30 วินาที แนะนำให้เรียกทุก ๆ นาที และรวมหลาย Agent เข้าในคำร้องเดียวกัน

การร้องขอ

ตัวอย่างการร้องขอ

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \ -H 'Authorization: Basic ${BASIC_TOKEN}'
                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/agent/stat/recent-activity?org_id=${org_id}&agent_id=${agent_id_1},${agent_id_2}&minutes=5' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

ส่วนหัวคำขอ

ฟิลด์ ประเภท คำอธิบาย
Authorization Basic ${BASIC_TOKEN} ใช้ Basic Token หลังจากเข้ารหัส Base64 ด้วย DevKey:DevSecret

พารามิเตอร์คำขอ

ฟิลด์ ประเภท จำเป็น คำอธิบาย
org_id String ใช่ ID ขององค์กร
agent_id String ใช่ ID ของตัวแทน หลายค่าใช้เครื่องหมายจุลภาคภาษาอังกฤษคั่น, สูงสุด 50 ค่า, ค่าเดียวกันนับครั้งเดียว ไม่รองรับ Workflow
minutes Integer ไม่ใช่ จำนวนเวลาล่าสุดเป็นนาที 1 ถึง 60, ค่าเริ่มต้น 5

การตอบสนอง

ตัวอย่างการตอบสนอง

{ "code": 0, "message": "OK", "data": { "minutes": 5, "window_start": 1790664900000, "window_end": 1790665200000, "agents": [ { "agent_id": "65f0c2a1b4e8d93a1c7e5b21", "new_conversation_count": 3, "new_message_count": 27 } ] } }
                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "minutes": 5,
        "window_start": 1790664900000,
        "window_end": 1790665200000,
        "agents": [
            {
                "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                "new_conversation_count": 3,
                "new_message_count": 27
            }
        ]
    }
}

                    
บล็อกโค้ดนี้ในหน้าต่างลอย

การตอบสนองสำเร็จ

ฟิลด์ ประเภท คำอธิบาย
minutes Integer ความยาวหน้าต่างการสถิติ (นาที)
window_start Long จุดเริ่มต้นหน้าต่าง (เวลามิลลิวินาที)
window_end Long จุดสิ้นสุดหน้าต่าง (เวลามิลลิวินาที, ไม่รวม)
agents[].agent_id String รหัส Agent, ลำดับตรงกับ agent_id ในคำขอ
agents[].new_conversation_count Long จำนวนการสนทนาใหม่ที่สร้างขึ้นภายในหน้าต่าง และมีการสนทนาเกิดขึ้นแล้ว
agents[].new_message_count Long จำนวนคำถามที่ผู้ใช้งานส่งภายในหน้าต่าง ไม่รวมการตอบกลับ AI

การตอบสนองล้มเหลว

ฟิลด์ ประเภท คำอธิบาย
code Integer รหัสข้อผิดพลาด
message String รายละเอียดข้อผิดพลาด

รหัสข้อผิดพลาด

รหัสสถานะ HTTP คือสามหลักแรกของรหัสข้อผิดพลาด เช่น 40000 ตรงกับ 400, 40100 ตรงกับ 401, 403132 ตรงกับ 403 |

รหัสข้อผิดพลาด คำอธิบาย
40000 พารามิเตอร์ไม่ถูกต้อง เช่น ขาดพารามิเตอร์ที่จำเป็นหรือค่าพารามิเตอร์ไม่ถูกต้อง
40001 เรียกใช้งานบ่อยเกินไป: คีย์นักพัฒนานี้เกินขีดจำกัดต่อหนึ่งนาทีของ API นี้
40008 เกินโควต้าต่อหนึ่งนาทีของ "API ด้านสถิติ" ของแพ็กเกจองค์กร
40010 API ปิดชั่วคราว กรุณาลองใหม่อีกครั้งในภายหลัง
40100 ไม่มีสิทธิ: ขาดสิทธิ์ดูการใช้งาน หรือไม่มีสิทธิ์เข้าดู Agent นี้ (รวมถึง Agent ไม่อยู่ในองค์กร)
40105 ไม่ใช่สมาชิกขององค์กรนี้ หรือเรียกใช้จากที่อยู่ของศูนย์ข้อมูลอื่น
40324 DevKey หรือ DevSecret ไม่ถูกต้อง
40378 Agent ถูกลบแล้ว
403132 ช่วงเวลาที่ไม่ถูกต้อง: เวลาเริ่มต้นไม่ก่อนเวลาสิ้นสุด หรือเกินช่วงการสอบถามสูงสุด.

ขอบเขตการสถิติ

  • ต้องดูทั้งสองตัวเลข: การสนทนาผ่านช่องทางการสื่อสารทันทีจะใช้การสนทนาเดียวกันต่อไปจนกว่าจะมีข้อความใหม่ภายใน 60 นาที และ Agent ที่ใช้งานช่องทางอย่างต่อเนื่องก็อาจไม่มีการสนทนาใหม่เป็นเวลานาน การดูเฉพาะจำนวนการสนทนาใหม่อาจประเมินผิดว่าไม่ใช้งาน.
  • ขอบเขตการสถิติ: สถิติจะครอบคลุมเฉพาะช่องทางในพื้นที่พัฒนา รวมถึง API, หน้าแชร์, การฝังเว็บ, ส่วนประกอบฟอง, LiveDesk และช่องทางการสื่อสารทันทีและโทรศัพท์ทั้งหมด; แต่ไม่รวมการดูตัวอย่างการดีบักในพื้นที่พัฒนา และการใช้งาน Agent ในพื้นที่ทำงาน.
  • ความถี่ในการอัปเดต: คำนวณแบบเรียลไทม์.