नेविगेशन पर जाएँ

कैरेक्टर उपयोग मेट्रिक्स पाएं

Deprecated

(बहिष्कृत) यह endpoint बहिष्कृत है। इसके बजाय /v1/workspace/analytics/query/usage-by-product-over-time का इस्तेमाल करें, जो bucket आकार को aggregation_interval के बजाय interval_seconds (सेकंड में एक पूर्णांक) के रूप में दिखाता है। यह मौजूदा यूज़र या उसके workspace के उपयोग मेट्रिक लौटाता है। रिस्पॉन्स, तय aggregation interval (डिफ़ॉल्ट: दिन) के आधार पर समय-अक्ष देता है, जिसमें उस अक्ष के हर interval के उपयोग मान होते हैं। उपयोग को चुने गए breakdown type के अनुसार विभाजित किया जाता है। उदाहरण के लिए, “voice” breakdown type समय-अक्ष के हर interval में हर वॉइस का उपयोग लौटाएगा।

हेडर

xi-api-keystringवैकल्पिक

क्वेरी पैरामीटर

start_unixintegerआवश्यक

उपयोग विंडो की शुरुआत के लिए मिलीसेकंड में UTC Unix timestamp। विंडो के पहले दिन को शामिल करने के लिए timestamp उस दिन के 00:00:00 पर होना चाहिए।

end_unixintegerआवश्यक

उपयोग विंडो के अंत के लिए मिलीसेकंड में UTC Unix timestamp। विंडो के आखिरी दिन को शामिल करने के लिए timestamp उस दिन के 23:59:59 पर होना चाहिए।

include_workspace_metricsbooleanवैकल्पिकडिफ़ॉल्ट: false

पूरे workspace के आंकड़े शामिल करने हैं या नहीं।

breakdown_typeenumवैकल्पिक

जानकारी को कैसे विभाजित करना है। अगर include_workspace_metrics False है, तो “user” नहीं हो सकता।

aggregation_intervalenumवैकल्पिक

समय के साथ उपयोग डेटा को कैसे एग्रीगेट करना है। “hour”, “day”, “week”, “month” या “cumulative” हो सकता है।

अनुमत मान:
aggregation_bucket_sizeinteger or nullवैकल्पिक

सेकंड में एग्रीगेशन बकेट का आकार। एग्रीगेशन अंतराल को ओवरराइड करता है।

metricenumवैकल्पिक

किस मेट्रिक को एग्रीगेट करना है।

रिस्पॉन्स

सफल रिस्पॉन्स

timelist of integers

हर दिन के लिए Unix टाइमस्टैंप वाली समय-अक्ष।

usagemap from strings to lists of doubles

समय-अक्ष के साथ हर ब्रेकडाउन टाइप का उपयोग।

त्रुटियाँ

422
Unprocessable Entity Error