การดึงสรุปการใช้งานขององค์กร

ดึงผลรวมของเครดิตที่ใช้ จำนวนเซสชันใหม่ และจำนวนคำถามของผู้ใช้ขององค์กรตามช่วงเวลา และขยายผลลัพธ์ตาม Agent / Workflow แบบแบ่งหน้า การเรียกครั้งเดียวสามารถรับข้อมูลของทุก Agent ในองค์กรได้ โดยไม่ต้องเรียกทีละ Agent

หมายเหตุ: สามารถสอบถามข้อมูลได้สูงสุด 31 วัน; สถิติรวมเฉพาะพื้นที่พัฒนาการใช้งาน ขอบเขตการนับสถิติตามที่ระบุด้านล่าง "เกณฑ์การนับสถิติ"

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

GET

ที่อยู่การเรียก

https://api-${endpoint}.gptbots.ai/v1/org/stat/summary

การตรวจสอบการเรียก

ใช้ Basic Authentication ของ DevKey / DevSecret ระดับบัญชี: Authorization: Basic ${BASIC_TOKEN} โดยที่ ${BASIC_TOKEN} คือการเข้ารหัส Base64 ของ DevKey:DevSecret

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

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

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

การร้องขอ

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

curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \ -H 'Authorization: Basic ${BASIC_TOKEN}'

                      
                      curl -X GET 'https://api-${endpoint}.gptbots.ai/v1/org/stat/summary?org_id=${org_id}&start_time=1792425600000&end_time=1795017600000&page=1&page_size=20' \
  -H 'Authorization: Basic ${BASIC_TOKEN}'

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

หัวข้อการขอข้อมูล

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

พารามิเตอร์การขอข้อมูล

ฟิลด์	ประเภท	จำเป็น	คำอธิบาย
org_id	String	ใช่	ID ขององค์กร
start_time	Long	ใช่	เวลาเริ่มต้น ในรูปแบบ timestamp มิลลิวินาที ขยายเวลาไปจนถึงเวลา 0 นาฬิกาของวันตามโซนเวลาขององค์กร
end_time	Long	ใช่	เวลาสิ้นสุด (ไม่รวม) ในรูปแบบ timestamp มิลลิวินาที ใช้วันธรรมชาติของมิลลิวินาทีสุดท้ายตามโซนเวลาขององค์กร วันที่เริ่มต้นและสิ้นสุดสามารถครอบคลุมได้สูงสุด 31 วัน
agent_type	String	ไม่จำเป็น	เลือกขยายเฉพาะประเภทใดประเภทหนึ่ง: `AGENT` หรือ `WORKFLOW`; หากไม่ส่ง จะรายการทั้งสองประเภท จะมีผลเฉพาะในรายการ `agents` ไม่ส่งผลต่อ `total`
page	Integer	ไม่จำเป็น	หมายเลขหน้า เริ่มจาก 1 โดยค่าเริ่มต้นคือ 1 สูงสุด 10000
page_size	Integer	ไม่จำเป็น	จำนวนรายการต่อหน้า โดยค่าเริ่มต้นคือ 20 สูงสุด 100

การตอบกลับ

ตัวอย่างการตอบกลับ

{ "code": 0, "message": "OK", "data": { "org_id": "65f0c2a1b4e8d93a1c7e5b20", "timezone": "+07:00", "range_start_date": "2026-10-16", "range_end_date": "2026-11-14", "data_since": "2026-10-15", "data_until": 1794614400000, "total": { "credits": 1234.5678, "unattributed_credits": 36.2011, "conversation_count": 5210, "message_count": 48213 }, "agents": { "page": 1, "page_size": 20, "total": 86, "list": [ { "agent_id": "65f0c2a1b4e8d93a1c7e5b21", "name": "客服助手", "agent_type": "AGENT", "credits": 402.1200, "conversation_count": 2104, "message_count": 19820 }, { "agent_id": "65f0c2a1b4e8d93a1c7e5b2a", "name": "订单查询", "agent_type": "WORKFLOW", "credits": 130.5000, "conversation_count": null, "message_count": null } ] } } }

                      
                      {
    "code": 0,
    "message": "OK",
    "data": {
        "org_id": "65f0c2a1b4e8d93a1c7e5b20",
        "timezone": "+07:00",
        "range_start_date": "2026-10-16",
        "range_end_date": "2026-11-14",
        "data_since": "2026-10-15",
        "data_until": 1794614400000,
        "total": {
            "credits": 1234.5678,
            "unattributed_credits": 36.2011,
            "conversation_count": 5210,
            "message_count": 48213
        },
        "agents": {
            "page": 1,
            "page_size": 20,
            "total": 86,
            "list": [
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b21",
                    "name": "客服助手",
                    "agent_type": "AGENT",
                    "credits": 402.1200,
                    "conversation_count": 2104,
                    "message_count": 19820
                },
                {
                    "agent_id": "65f0c2a1b4e8d93a1c7e5b2a",
                    "name": "订单查询",
                    "agent_type": "WORKFLOW",
                    "credits": 130.5000,
                    "conversation_count": null,
                    "message_count": null
                }
            ]
        }
    }
}

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

การตอบกลับสำเร็จ

ฟิลด์	ประเภท	คำอธิบาย
org_id	String	รหัสองค์กร
timezone	String	เขตเวลาองค์กร (การเลื่อน UTC เช่น `+07:00`) ระบุว่าข้อมูลวันที่ถูกแบ่งตามเขตเวลาใด
range_start_date	String	วันที่เริ่มต้นการสถิติจริง `yyyy-MM-dd` (เขตเวลาองค์กร รวม)
range_end_date	String	วันที่สิ้นสุดการสถิติจริง `yyyy-MM-dd` (เขตเวลาองค์กร รวม)
data_since	String	วันที่ข้อมูลครบถ้วนที่สุดเริ่มต้น (`yyyy-MM-dd`): เครดิตเริ่มมีตั้งแต่วันเปิดใช้งานฟีเจอร์ จำนวนการสนทนาและคำถามเริ่มมีตั้งแต่ 31 วันก่อนเปิดใช้งาน เลือกวันที่ช้าที่สุดจากสองค่าดังกล่าว ข้อมูลก่อนหน้านั้นไม่ครบถ้วน หากยังไม่มีข้อมูลใด ๆ จะเป็น `null`
data_until	Long	เวลาที่ได้สถิติการสนทนาและคำถามจนถึง (เวลาประทับในมิลลิวินาที) เครดิตเป็นแบบเรียลไทม์
total.credits	Number	ยอดรวมการใช้เครดิตขององค์กร รวมทั้ง Workflow และการใช้ที่ไม่อยู่ในความรับผิดชอบของ Agent ใด ๆ เก็บทศนิยม 4 หลัก
total.unattributed_credits	Number	ส่วนที่ไม่อยู่ในความรับผิดชอบของ Agent ใด ๆ (เช่น การจัดเก็บ Knowledge Base, การรู้จำเสียง) จะไม่ปรากฏในรายชื่อ `agents`
total.conversation_count	Long	จำนวนการสนทนาที่สร้างใหม่ในช่วงเวลานั้นทั้งหมด
total.message_count	Long	จำนวนคำถามของผู้ใช้ในช่วงเวลานั้นทั้งหมด ไม่รวมการตอบของ AI
agents.page	Integer	หมายเลขหน้าปัจจุบัน
agents.page_size	Integer	จำนวนรายการต่อหน้า
agents.total	Integer	จำนวน Agent และ Workflow ที่มีข้อมูลในช่วงเวลานั้น (กรองตาม `agent_type`).
agents.list[].agent_id	String	ID ของ Agent หรือ Workflow.
agents.list[].name	String	ชื่อ.
agents.list[].agent_type	String	`AGENT` หรือ `WORKFLOW`.
agents.list[].credits	Number	เครดิตที่ใช้ไป.
agents.list[].conversation_count	Long	จำนวนบทสนทนาที่สร้างใหม่ในช่วงเวลา; Workflow คือ `null`.
agents.list[].message_count	Long	จำนวนคำถามจากผู้ใช้ในช่วงเวลา; Workflow คือ `null`.

การตอบกลับเมื่อไม่สำเร็จ

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

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

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

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

ขอบเขตสถิติ

ขอบเขตการสถิติ: นับเฉพาะ DevSpace รวมถึง API, หน้าแชร์, การฝังบนเว็บ, ส่วนประกอบฟอง, LiveDesk และช่องทางการสื่อสารทันทีและโทรศัพท์ต่าง ๆ รวมถึง Workflow ของ DevSpace; ไม่รวมการใช้งานของ Workspace (GWork) และไม่รวมการใช้งานของ Agent ที่เผยแพร่แล้วใน Workspace
เครดิต: ครอบคลุมทุกประเภทการใช้ (ไม่รวมการหมดอายุของเครดิตและการชำระค่าสมัครสมาชิก) การใช้ของ Workflow บันทึกภายใต้ชื่อ Workflow เอง การเรียกใช้งาน Agent ที่เกิดจาก Workflow จะไม่ถูกนับรวมใน Agent นั้น ข้อมูลเครดิตเริ่มตั้งแต่วันที่ฟังก์ชันเปิดใช้งาน (data_since) โดยไม่เติมย้อนหลัง
จำนวนเซสชัน: จำนวนเซสชันที่สร้างใหม่และมีการสนทนาภายในช่วงเวลา ไม่รวมการดีบักและพรีวิวใน DevSpace; การรัน Workflow จะไม่สร้างเซสชัน; การค้นหา AI ใน Workspace จะไม่ถูกนับ จำนวนเซสชันและคำถามเริ่มมีข้อมูลตั้งแต่ 31 วันก่อนเปิดใช้งานฟังก์ชัน
จำนวนคำถาม: จำนวนข้อความคำถามที่ผู้ใช้ส่งภายในช่วงเวลา ไม่รวมคำตอบจาก AI
การจัดลำดับ: agents.list จัดเรียงเครดิตจากมากไปน้อย หากเครดิตเท่ากันจะจัดตามจำนวนเซสชัน Agent ที่ไม่มีเครดิต เซสชัน และคำถามในช่วงเวลาดังกล่าวจะไม่แสดง
ความถี่ในการอัพเดต: เครดิตอัพเดตแบบเรียลไทม์; จำนวนเซสชันและคำถามสถิติทุกชั่วโมงโดยมีความล่าช้าประมาณ 1 ชั่วโมง