Enterprise
यह एक एंटरप्राइज़ API है, जो केवल हमारे managed access levels में उपलब्ध है। इस API का उपयोग करने के लिए, आपको पहले हमारी enterprise sales team के साथ एक खाता सेट अप करना होगा। और जानें
Engagement API, पोस्ट impression और engagement metrics तक पहुंच प्रदान करता है। हालांकि, अधिकांश metrics और endpoints के लिए आपको OAuth 1.0a User Context का उपयोग करके प्रमाणित करना होता है, लेकिन आप OAuth 2.0 बेयरर टोकन और /totals endpoint का उपयोग करके public Favorite, Retweet, Reply, और Video Views metrics तक पहुंच सकते हैं।
ध्यान दें: आप X के कुछ web dashboards पर रिपोर्ट किए गए डेटा और Engagement API में रिपोर्ट किए गए डेटा के बीच अंतर देख सकते हैं। ऐसा इसलिए होता है क्योंकि web dashboards आमतौर पर केवल वही engagements और/या impressions दिखाते हैं, जो चुनी गई समय-सीमा के भीतर हुए हों। उदाहरण के लिए, कोई web dashboard किसी कैलेंडर महीने की अवधि में पोस्ट्स पर engagement दिखा सकता है, जबकि Engagement API ऐसे engagements दिखा सकता है जो उस महीने की अवधि से बाहर हों, लेकिन अनुरोधित समय-सीमा के भीतर आते हों। ऐसे मामलों में Engagement API को ही मान्य स्रोत माना जाना चाहिए।
Engagement API के तीन एंडपॉइंट हैं:
- अनुरोध वांछित पोस्ट्स के लिए इम्प्रेशंस और एंगेजमेंट्स, दोनों के कुल मेट्रिक लौटाते हैं
- निम्न मेट्रिक्स तक सीमित: Impressions, Engagements, Favorites, Replies, Retweets, Quote Tweets, और Video Views
- OAuth 1.0a User Context का उपयोग करके पिछले 90 दिनों के भीतर बनाई गई पोस्ट्स के लिए Impressions और Engagements मेट्रिक्स प्राप्त किए जा सकते हैं
- OAuth 2.0 बेयरर टोकन का उपयोग करके किसी भी पोस्ट के लिए Favorites, Retweets, Quote Tweets, Replies, और Video Views मेट्रिक्स प्राप्त किए जा सकते हैं
- परिणाम, अनुरोध किए जाने के समय इम्प्रेशंस और एंगेजमेंट्स के वर्तमान कुल पर आधारित होते हैं
- डैशबोर्ड रिपोर्ट को सक्षम बनाने और विभिन्न @हैंडलों में एंगेजमेंट दरों की गणना के लिए आदर्श
- प्रति अनुरोध अधिकतम 250 पोस्ट्स के लिए मेट्रिक्स का अनुरोध किया जा सकता है
- अनुरोध पिछले 28 घंटों में हुए इम्प्रेशंस का कुल मेट्रिक, एंगेजमेंट्स का कुल मेट्रिक, और अलग-अलग एंगेजमेंट मेट्रिक्स का विवरण लौटा सकते हैं
- डेटा को पोस्ट ID के अनुसार समूहित किया जा सकता hai, और समय-श्रृंखला में समेकित रूप से, दिन के हिसाब से, या घंटे के हिसाब से भी दिखाया जा सकता है
- हाल ही में बनाई गई सामग्री के प्रदर्शन को ट्रैक करने के लिए उपयुक्त
- सभी उपलब्ध मेट्रिक्स का समर्थन करता है
- प्रति अनुरोध अधिकतम 25 पोस्ट्स के लिए मेट्रिक्स का अनुरोध करने का समर्थन करता है
- अनुरोध इम्प्रेशन, एंगेजमेंट, और सबसे हाल के एक वर्ष के लिए अलग-अलग एंगेजमेंट मेट्रिक्स का विवरण लौटा सकते हैं। यह एंगेजमेंट के समय पर आधारित होता है (पोस्ट बनाए जाने के समय पर नहीं)।
- अनुरोध
start dateऔरend dateपैरामीटर का समर्थन करते हैं, जिससे 4 सप्ताह तक की किसी विशिष्ट समयावधि को चुनने की सुविधा मिलती है। - पोस्ट एंगेजमेंट डेटा केवल पिछले 365 दिनों तक उपलब्ध है।
- डेटा को पोस्ट id के आधार पर समूहित किया जा सकता है, और टाइम-सीरीज़ में समग्र रूप से, दिन के अनुसार, या घंटे के अनुसार भी देखा जा सकता है।
- हाल के प्रदर्शन की तुलना ऐतिहासिक मानक से करने या किसी @handle के प्रदर्शन की ऐतिहासिक तस्वीर तैयार करने के लिए उपयुक्त।
- सभी उपलब्ध मेट्रिक्स का समर्थन करता है।
- प्रति अनुरोध अधिकतम 25 पोस्ट्स के लिए मेट्रिक्स का अनुरोध करने का समर्थन करता है।
समूहीकरण से लौटाए गए एंगेजमेंट मेट्रिक्स को कस्टम तरीके से व्यवस्थित किया जा सकता है। आप प्रत्येक अनुरोध में अधिकतम 3 समूहीकरण शामिल कर सकते हैं। आप मेट्रिक्स को निम्नलिखित में से एक या अधिक मानों के आधार पर समूहित कर सकते हैं:
सभी तीनों एंडपॉइंट इसका समर्थन करते हैं:
- tweet.id
- engagement.type
/28hr और /historical समय-श्रृंखला मेट्रिक्स प्रदान कर सकते हैं, इसलिए ये इसका भी समर्थन करते हैं:
- engagement.day
- engagement.hour
Engagement API क्या प्रदान करता है?
- Engagement API पिछले 90 दिनों के दौरान किसी भी X खाते के स्वामित्व वाले पोस्ट्स के लिए impression और engagement डेटा प्रदान करता है, बशर्ते उस खाते ने 3-legged OAuth का उपयोग करके आपकी ऐप को अपनी ओर से metrics का अनुरोध करने की अनुमति दी हो। यह शक्तिशाली लेकिन लागू करने में आसान समाधान impressions और गहरे engagements, जैसे URL clicks, #hashtag clicks, आदि तक तुरंत पहुँच प्रदान करता है।
- Engagement API किसी भी पोस्ट के लिए favorites, Retweets, Quote Tweets, replies और video views के कुल समेकित metrics प्रदान करता है। इसका उपयोग किसी भी पोस्ट या पोस्ट्स के संग्रह के बारे में बुनियादी engagement डेटा प्राप्त करने के एक प्रभावी तरीके के रूप में किया जा सकता है।
- Engagement API, 15+ performance metrics का उपयोग करके सामग्री के प्रदर्शन को प्रभावी ढंग से मापने की सुविधा देकर, social listening, marketing और publishing platforms के लिए नया मूल्य प्रदान करता है, जिससे ग्राहक X पर ROI माप सकते हैं।
- Engagement API एक request/response API है, जो ऐप डेवलपर्स को पोस्ट IDs, वांछित metrics और एक time frame के साथ अनुरोध भेजने की अनुमति देता है, जिसके जवाब में API तुरंत डेटा लौटाता है।
एकीकृत क्यों करें? उदाहरण उपयोग के मामले
- अपने कॉन्टेंट की कुल पहुँच को समझें, ताकि आप देख सकें कि उसे कितने लोग देखते हैं। यह भी देखें कि कितने लोग वीडियो देखते हैं, लिंक पर क्लिक करते हैं, हैशटैग पर क्लिक करते हैं, या मेरे ऐप्स इंस्टॉल करते हैं।
- कुल और समय-श्रृंखला, दोनों तरह के एंगेजमेंट मेट्रिक्स जनरेट करें।
- किसी भी सार्वजनिक पोस्ट के लिए बुनियादी एंगेजमेंट मेट्रिक्स (पसंद, Retweets, Quote Tweets, जवाब) समझें।
- इन मेट्रिक्स का उपयोग यह तय करने के लिए करें कि किस तरह की पोस्ट्स बेहतर काम करती हैं, ताकि मैं उन्हें अधिक बार पोस्ट कर सकूँ और अपने कॉन्टेंट के लिए अधिक इम्प्रेशन और एंगेजमेंट प्राप्त कर सकूँ।
- जब भी मेरी किसी पोस्ट को 100 Likes, या कोई अन्य सीमा, मिल जाए, तब मार्केटिंग गतिविधियों को स्वचालित करें (जैसे किसी दूसरे स्वामित्व वाले खाते से कॉन्टेंट को Retweet करना)।
- A/B परीक्षण के लिए एक टूल के रूप में अपने अभियानों का बेंचमार्क करें और उनकी आपस में तुलना करें।
- यह विश्लेषण करें कि आपके ग्राहक सेवा विभाग के लिए किस तरह का कॉन्टेंट सबसे अधिक प्रभावी है, ताकि यह तय किया जा सके कि कैसे और कब प्रतिक्रिया देनी है।
- मेरे प्लेटफ़ॉर्म से प्रकाशित किए गए कॉन्टेंट के लिए एनालिटिक्स दिखाएँ।
API का परिचय
- पोस्ट IDs की array.
- रुचि के metric types निर्दिष्ट करने वाली array. Types में ‘impressions’, ‘retweets’, ‘hashtag_clicks’ और ‘user_follows’ जैसी चीज़ें शामिल हैं।
- Engagement groupings, जो एक JSON संरचना है और यह बताती है कि आप API response में engagement data को किस तरह व्यवस्थित करना चाहते हैं।
- Totals - पोस्ट्स के लिए engagements का कुल योग प्रदान करता है। कुछ metrics सभी पोस्ट्स के लिए उपलब्ध होते हैं, जबकि अन्य केवल पिछले 90 दिनों के लिए उपलब्ध होते हैं।
- 28 hour - पिछले 28 घंटों के time-series engagement metrics प्रदान करता है।
- Historical - 1 सितंबर, 2014 के बाद किए गए पोस्ट्स के लिए अधिकतम लगातार चार सप्ताह तक के time-series engagement metrics प्रदान करता है।
API ऐक्सेस प्राप्त करना
अनुरोध करना
1/ आज हम X API प्लेटफ़ॉर्म के भविष्य के लिए अपना विज़न साझा कर रहे हैं— Twitter Dev (@TwitterDev) 6 अप्रैल, 2017
अपने पोस्ट के बारे में पोस्ट्स देखना न चूकें। अब iOS पर, आप टिप्पणियों वाले Retweets को एक ही जगह पर देख सकते हैं। pic.x.com/oanjZfzC6y — X (@X) 12 मई, 2020पहला चरण JSON में API अनुरोध तैयार करना है। इसमें इन दो पोस्ट id को एक array में रखा जाता है, रुचि के engagement types की एक array दी जाती है, और “groupings” नाम का एक कस्टम JSON object शामिल होता है, जो यह बताता है कि response में metrics को किस तरह व्यवस्थित करना है। हमारा अनुरोध इस प्रकार दिखता है:
- Content-Type: application/json
- Accept-Encoding: gzip
- टोटल्स - ‘स्वामित्व वाले’ या ‘गैर-स्वामित्व वाले’ पोस्ट्स से चुने गए मेट्रिक्स के कुल योग उपलब्ध कराता है। कुछ मेट्रिक्स सभी पोस्ट्स के लिए उपलब्ध हैं, जबकि अन्य केवल पिछले 90 दिनों में प्रकाशित पोस्ट्स के लिए ही उपलब्ध हैं। प्रति अनुरोध 250 पोस्ट्स तक समर्थित हैं।
- 28 घंटे - पिछले 28 घंटों के ‘स्वामित्व वाले’ पोस्ट्स के लिए समय-श्रृंखला Engagement मेट्रिक्स उपलब्ध कराता है। प्रति अनुरोध 25 पोस्ट्स तक समर्थित हैं।
- ऐतिहासिक - 1 सितंबर, 2014 से किए गए ‘स्वामित्व वाले’ पोस्ट्स के लिए लगातार अधिकतम चार सप्ताह तक के समय-श्रृंखला Engagement मेट्रिक्स उपलब्ध कराता है। प्रति अनुरोध 25 पोस्ट्स तक समर्थित हैं।
इंप्रेशन और एंगेजमेंट मेट्रिक्स
स्वामित्व वाली और गैर-स्वामित्व वाली X सामग्री
कुल और समय-श्रृंखला सहभागिता डेटा
/totals
- मुझे केवल कुछ मेट्रिक प्रकारों (Impressions, Engagements, Favorites, Retweets, Quote Tweets, Replies, और Video Views) तक पहुंच चाहिए।
- मुझे किसी भी पोस्ट के लिए बुनियादी एंगेजमेंट डेटा चाहिए, सिर्फ मेरी अपनी पोस्ट्स के लिए नहीं।
- मैं किसी प्रतिस्पर्धी की तुलना में प्रदर्शन देखना चाहता/चाहती हूँ।
- मैं किसी हैशटैग या अभियान के लिए बुनियादी एंगेजमेंट आँकड़े ट्रैक करना चाहता/चाहती हूँ, जिसमें ऐसी पोस्ट्स शामिल हों जो मेरी नहीं हैं।
- मुझे दिन या घंटे के हिसाब से विभाजित डेटा की जरूरत नहीं है; अनुरोध करते समय मुझे सिर्फ मौजूदा कुल चाहिए।
- मुझे किसी रिपोर्ट या डैशबोर्ड में दिखाने के लिए एक ही मेट्रिक चाहिए, और मैं कोई डेटा स्टोर नहीं करना चाहता/चाहती।
- मैं पेज लोड होने के समय डेटा दिखाना चाहता/चाहती हूँ, और इसके लिए मुझे सिर्फ एक अनुरोध करके उसका रिस्पॉन्स चाहिए।
- मुझे हर दिन सैकड़ों हजारों या लाखों पोस्ट्स का डेटा पाने की सुविधा चाहिए।
/28hr
- मुझे सभी 17 मेट्रिक प्रकारों तक पहुंच चाहिए।
- मैं पिछले 28 घंटों में प्रकाशित हुई हाल की पोस्ट्स का डेटा दिखाना चाहता हूँ।
- मेरे पास एक जॉब है जो दिन में एक बार चलती है, ताकि मुझे ज़रूरी डेटा मिल सके, और मुझे केवल पिछले दिन का डेटा चाहिए।
- मुझे मेट्रिक्स का विभाजन दिन या घंटे के हिसाब से चाहिए।
- मैं डैशबोर्ड में घंटे के हिसाब से गतिविधि का time-series विभाजन दिखाना चाहता हूँ।
- मुझे हर दिन सैकड़ों हज़ार पोस्ट्स के लिए उच्च एक्सेस चाहिए।
- मेरे पास स्टोरेज की क्षमता है और मैं दिन में एक बार डेटा refresh करके चलता हुआ tally बनाए रख सकता हूँ।
/historical
- मुझे सभी 17 मेट्रिक प्रकार तक ऐक्सेस चाहिए।
- मुझे सितंबर 2014 तक बनाए गए पोस्ट्स का ऐतिहासिक डेटा चाहिए।
- मैं ऐसा विस्तृत ऐतिहासिक विश्लेषण दिखाना चाहता हूँ, जिसमें campaigns की तुलना की गई हो।
- मुझे metrics दिन या घंटे के हिसाब से विभाजित चाहिए।
- मुझे Engagement API तक उच्च-स्तरीय ऐक्सेस की आवश्यकता नहीं है और मुझे केवल प्रतिदिन कुछ सौ या हज़ार पोस्ट्स का डेटा चाहिए।
- JSON डेटा देने वाला RESTful API, जो JSON डेटा बॉडी के साथ POST अनुरोधों का समर्थन करता है।
- अनुरोधों के प्रकार: क्लाइंट ऐप्स निम्न प्रकार के अनुरोध कर सकते हैं:
- कुल एंगेजमेंट्स — /totals endpoint पर HTTP POST अनुरोध
- पिछले 28 घंटों के एंगेजमेंट्स — /28hr endpoint पर HTTP POST अनुरोध
- ऐतिहासिक एंगेजमेंट्स — /historical endpoint पर HTTP POST अनुरोध
- OAuth प्रमाणीकरण:
- OAuth 1.0 User Context: 3-legged OAuth का उपयोग करके आपके ऐप को अधिकृत करने वाले उपयोगकर्ता के स्वामित्व वाली पोस्ट्स के लिए सभी उपलब्ध मेट्रिक्स उपलब्ध हैं। अनुरोध करते समय आपको उसी उपयोगकर्ता के Access Tokens का उपयोग करना होगा।
- OAuth 2.0 बेयरर टोकन: चयनित मेट्रिक्स (Retweets, Quote Tweets, Replies, Favorites, और Video Views) किसी भी सार्वजनिक पोस्ट के लिए उपलब्ध हैं।
- अनुरोध metadata और संरचना: अनुरोध डेटा एक JSON ऑब्जेक्ट होता है, जिसमें Post ID की array, engagement प्रकारों की एक array, और एक engagement grouping संरचना शामिल होती है।
- प्रति अनुरोध पोस्ट्स:
- /totals endpoint: 250 Post IDs
- /28hr endpoint: 25 Post IDs
- /historical endpoint: 25 Post IDs
- Engagement metrics की उपलब्धता:
- /totals — पोस्ट प्रकाशित होने के बाद से metric totals। पिछले 90 दिनों में प्रकाशित पोस्ट्स के लिए Impressions और Engagements उपलब्ध हैं, जबकि Retweets, Quote Tweets, Replies, Favorites, और Video Views सभी पोस्ट्स के लिए उपलब्ध हैं।
- /28hr — अनुरोध के समय से पिछले 28 घंटे।
- /historical — 1 सितंबर, 2014 से शुरू होने वाली कोई भी 28-दिवसीय अवधि।
- मेट्रिक प्रकार: प्रत्येक अनुरोध में मेट्रिक प्रकार की एक array शामिल होती है। इनकी उपलब्धता endpoint पर निर्भर करती है और, यदि /totals endpoint से अनुरोध किया जा रहा है, तो इस बात पर भी कि पोस्ट्स user-permissioned हैं या नहीं।
- /totals endpoint:
- सभी पोस्ट्स: Favorites, Retweets, Quote Tweets, Replies, और Video Views
- OAuth 1.0a User Context आवश्यक: Impressions, Engagements, Favorites, Replies, और Retweets
- /28hr और /historical endpoints (पोस्ट के स्वामी के Access Token के साथ OAuth 1.0a User Context आवश्यक): Impressions, Engagements, Favorites, Replies, Retweets, URL Clicks, Hashtag Clicks, Detail Click, Permalink Clicks, Media Clicks, App Install Attempts, App Opens, Post Emails, Video Views, और Media Views
- /totals endpoint:
- Engagement समूहीकरण: प्रत्येक अनुरोध में Engagement समूहीकरण की एक array शामिल होती है। इन समूहीकरणों की मदद से आप यह अनुकूलित कर सकते हैं कि लौटाए गए metrics कैसे व्यवस्थित हों। प्रत्येक अनुरोध में अधिकतम तीन समूहीकरण शामिल किए जा सकते हैं। Metrics को निम्न मानों के आधार पर व्यवस्थित किया जा सकता है:
- सभी endpoints: Post ID, Engagement Type
- /28hr और /historical endpoints: यदि ये अतिरिक्त समूहीकरण निर्दिष्ट की जाती हैं, तो ये endpoints time-series प्रदान करते हैं: Engagement Day, Engagement Hour
- इंटीग्रेशन अपेक्षाएँ: आपकी टीम निम्न के लिए ज़िम्मेदार होगी।
- ऐसा क्लाइंट ऐप बनाना और बनाए रखना, जो Engagement API को HTTP requests भेज सके और अनुरोध में शामिल Post ID के लिए engagement metrics लौटा सके।
- सीमाएँ
- Video views केवल उन पोस्ट्स के लिए उपलब्ध हैं जो 1800 दिनों या उससे कम पुरानी हैं।
कृपया ध्यान दें: API का उपयोग शुरू करने से पहले X को आपके डेवलपर ऐप के लिए Engagement API की ऐक्सेस सक्षम करनी होगी। इसके लिए, सुनिश्चित करें कि आप प्रमाणीकरण के लिए जिस App ID का उपयोग करना चाहते हैं, उसे अपने अकाउंट मैनेजर या तकनीकी सहायता टीम के साथ साझा करें।Engagement API के साथ प्रमाणीकरण की दो विधियाँ उपलब्ध हैं: OAuth 1.0a और OAuth 2.0 बेयरर टोकन. OAuth 2.0 बेयरर टोकन (जिसे “application-only” भी कहा जाता है) आपको सार्वजनिक रूप से उपलब्ध एंगेजमेंट मेट्रिक्स तक पहुँचने की अनुमति देता है। इस प्रमाणीकरण विधि का उपयोग /totals endpoint पर अनुरोध करते समय किसी भी सार्वजनिक रूप से उपलब्ध पोस्ट्स के लिए Favorites (यानी Likes), Retweets, Quote Tweets, Replies और वीडियो व्यूज़ की कुल संख्या प्राप्त करने के लिए किया जा सकता है। OAuth 1.0a (जिसे “user context” भी कहा जाता है) आपको किसी उपयोगकर्ता की ओर से अनुरोध करने और उस उपयोगकर्ता से संबंधित निजी एंगेजमेंट मेट्रिक्स तक पहुँचने की अनुमति देता है। यह प्रमाणीकरण विधि इन मामलों में आवश्यक है:
- /28hr endpoint और /historical endpoint को भेजे गए सभी अनुरोधों के लिए
- निम्नलिखित निजी मेट्रिक्स में से किसी भी मेट्रिक तक पहुँचने के लिए: Impressions, Engagements, Media Views, Media Engagements, URL Clicks, Hashtag Clicks, Detail Expands, Permalink Clicks, App Install Attempts, App Opens, Email Post, User Follows, और User Profile Clicks
403 Forbidden त्रुटि लौटाएगा।
Engagement API आपको protected Posts के लिए एंगेजमेंट डेटा फ़ेच करने की अनुमति नहीं देगा, भले ही आप उन पोस्ट्स के स्वामी उपयोगकर्ता की ओर से प्रमाणीकरण कर रहे हों। ऐसा करने का प्रयास करने पर "Tweet ID(s) are unavailable" संदेश के साथ 400 Bad Request त्रुटि लौटेगी।
यदि आप अपने स्वयं के X अकाउंट की ओर से अनुरोध भेज रहे हैं (दूसरे शब्दों में, वह अकाउंट जो डेवलपर ऐप का स्वामी है), तो आप आवश्यक Access Tokens सीधे Developer Console में डेवलपर ऐप के “Keys and tokens” टैब के अंतर्गत जनरेट कर सकते हैं।
यदि आप किसी अन्य उपयोगकर्ता की ओर से अनुरोध कर रहे हैं, तो आवश्यक Access Tokens प्राप्त करने के लिए आपको 3-legged OAuth flow का उपयोग करना होगा। इसे कैसे करना है, इस बारे में अधिक जानकारी के लिए यह दस्तावेज़ देखें: OAuth 1.0a: उपयोगकर्ता के access tokens कैसे प्राप्त करें.
अतिरिक्त उदाहरणों के लिए, जिनमें OAuth 1.0a का उपयोग करके प्रमाणीकरण करना भी शामिल है, XDevelopers sample Python code for the Engagement API देखें।
Engagement API मूल्यवान impression और engagement मेट्रिक्स प्रदान करता है, जिनकी मदद से आप X पर अपनी गतिविधि के प्रदर्शन की निगरानी कर सकते हैं। हमारे डेटा के आधार पर मार्केटिंग निर्णयों को सक्षम बनाने के अपने निरंतर प्रयास के तहत, हमें Engagement API में हुए हाल के बदलाव साझा करते हुए खुशी हो रही है, जो X के सभी हिस्सों में मेट्रिक्स के साथ बेहतर सुसंगति प्रदान करते हैं।
हमने हाल ही में Engagement API को आधुनिक बनाने के लिए बदलाव लागू किए हैं, ताकि यह X analytics dashboard (analytics.x.com) में उपयोग की जा रही वही metrics aggregation methodology इस्तेमाल करे। इन नए मेट्रिक्स को लागू करते समय breaking API changes को यथासंभव कम रखने के लिए हमने सावधानीपूर्वक तरीका अपनाया और बदलावों का पहला सेट 9 अक्टूबर, 2017 को लागू किया। ये बदलाव उन सभी जगहों पर सुसंगति बेहतर करते हैं, जहाँ आप या आपके ग्राहक X पर अपने प्रदर्शन की निगरानी कर सकते हैं। कृपया नीचे बदलावों का विस्तृत विवरण देखें:
नोट: आप X के कुछ वेब डैशबोर्ड पर दिखाए गए डेटा और Engagement API में रिपोर्ट किए गए डेटा के बीच अंतर देख सकते हैं। ये अंतर इसलिए होते हैं क्योंकि वेब डैशबोर्ड आम तौर पर केवल वही एंगेजमेंट और/या इम्प्रेशंस दिखाते हैं, जो चुनी गई समय-सीमा के भीतर हुए हों। उदाहरण के लिए, कोई वेब डैशबोर्ड किसी कैलेंडर माह के दौरान पोस्ट्स पर हुए एंगेजमेंट दिखा सकता है, जबकि Engagement API ऐसे एंगेजमेंट दिखा सकता है जो उस माह की अवधि से बाहर हों, लेकिन अनुरोधित समय-सीमा के भीतर आते हों। ऐसे मामलों में, Engagement API को मान्य स्रोत माना जाना चाहिए।
Engagement API ऑर्गेनिक इंप्रेशन और एंगेजमेंट डेटा प्रदान करता है।
इंप्रेशन उस संख्या को दर्शाते हैं कि X प्लेटफ़ॉर्म पर किसी दिए गए पोस्ट को ऑर्गेनिक संदर्भ में कितनी बार देखा गया। Promoted या Paid संदर्भ में देखे गए पोस्ट्स से उत्पन्न इंप्रेशन शामिल नहीं होते।
एंगेजमेंट उस संख्या को दर्शाते हैं कि किसी दर्शक ने किसी दिए गए पोस्ट के साथ ऑर्गेनिक और प्रमोटेड दोनों संदर्भों में कितनी बार इंटरैक्ट किया। एंगेजमेंट में Retweets, Favorites, Replies, URL Clicks, Hashtag Clicks, Mention Clicks और Media Views शामिल हैं, लेकिन ये इन्हीं तक सीमित नहीं हैं। शामिल एंगेजमेंट कार्रवाइयों की पूरी सूची के लिए, कृपया Engagement Data अनुभाग देखें।
आधारभूत एंगेजमेंट दर की गणना करने के लिए, जिस समयावधि का आप विश्लेषण कर रहे हैं उसमें किसी दिए गए पोस्ट के लिए कुल एंगेजमेंट को कुल इंप्रेशन से विभाजित करें।
इंप्रेशन और एंगेजमेंट डेटा केवल स्वामित्व वाले @handles के पोस्ट्स के लिए, या उन @handles के लिए प्राप्त किया जा सकता है जिन्होंने आपके ऐप को अपने पोस्ट्स के बारे में विवरण देखने की अनुमति दी है। आंतरिक रूप से, Engagement API अनुबंधित @handle सीमा के विरुद्ध अनुरोध किए गए अद्वितीय @handles की संख्या को ट्रैक करेगा। यह भी अनुशंसित है कि आप पूरे महीने के दौरान क्लाइंट-साइड पर @handle अनुरोध उपयोग को ट्रैक करें।
X में मीडिया इम्प्रेशन्स को दर्शाने वाले कुछ अलग-अलग मेट्रिक्स हैं। इनमें पहला हमारा वीडियो व्यूज़ मेट्रिक है, जो MRC मानक पर आधारित है, जिसके अनुसार कम-से-कम दो सेकंड तक वीडियो का 50% हिस्सा स्क्रीन पर दिखाई देना चाहिए। दूसरा Media Views है, जिसमें आपके मीडिया के सभी व्यूज़ (autoplay और click) शामिल होते हैं, जिन्हें videos, vines, gifs, और images में गिना जाता है।
वीडियो व्यूज़ मेट्रिक owned पोस्ट्स के लिए /28hour और /historical endpoints के माध्यम से उपलब्ध है, और सभी unowned पोस्ट्स के लिए /totals endpoint के माध्यम से भी उपलब्ध है।
हालाँकि X user interface में वीडियो व्यूज़ मेट्रिक भी उसी MRC मानक का उपयोग करता है, कृपया ध्यान दें कि X के owned and operated platforms (mobile app और website) पर दिखाए गए वीडियो व्यूज़ मेट्रिक और अलग-अलग Engagement API endpoints के माध्यम से प्राप्त संख्या में अंतर दिखाई दे सकता है।
- /totals endpoint और X user interface द्वारा दिए गए वीडियो व्यूज़ उस वीडियो के लिए उन सभी पोस्ट्स में एकीकृत कुल वीडियो व्यूज़ दिखाते हैं, जिनमें वह वीडियो पोस्ट किया गया है। इसका मतलब है कि /totals के माध्यम से दिया गया और X UI में दिखाया गया मेट्रिक उन सभी अलग-अलग पोस्ट्स के संयुक्त व्यूज़ शामिल करता है, जहाँ उस वीडियो को Retweet या repost किया गया है।
- /28hour और /historical Engagement API endpoints द्वारा दिए गए वीडियो व्यूज़ में केवल वही व्यूज़ शामिल होंगे, जो उस विशिष्ट पोस्ट से उत्पन्न हुए हैं जिसके लिए आप मेट्रिक्स प्राप्त कर रहे हैं।
- tweet.id
- engagement.type
/28hr और /historical time-series मेट्रिक्स प्रदान कर सकते हैं, इसलिए ये इनका भी समर्थन करते हैं:
- engagement.day
- engagement.hour
group_by मानों का क्रम बदलकर इच्छित परिणाम प्रारूप बदल सकते हैं। जिन समूहीकरणों में चार group_by मान होते हैं, वे केवल निम्नलिखित दो प्रारूपों में से किसी एक में ही समर्थित होते हैं:
"Grand Totals" गुण शामिल होगा, जिसमें मेट्रिक्स type के अनुसार कुल योग शामिल होंगे:
"Tweets_MetricType_TimeSeries" attribute शामिल होगा, जिसमें metrics को पहले पोस्ट ID, फिर metric type, और उसके अनुरूप प्रति-घंटा time-series के हिसाब से विभाजित किया गया होगा:
Enterprise
मैं Engagement API तक कैसे पहुँच सकता/सकती हूँ?
मैं Engagement API तक कैसे पहुँच सकता/सकती हूँ?
Engagement API की पहुँच enterprise subscription के माध्यम से प्रदान की जाती है। हमारी sales team से संपर्क करने के लिए कृपया यह फ़ॉर्म भरें।
'@handle' के आधार पर मेरे उपयोग को कैसे ट्रैक किया जाता है?
'@handle' के आधार पर मेरे उपयोग को कैसे ट्रैक किया जाता है?
यदि आपके contract में Engagement API के साथ उपयोग किए जा सकने वाले unique handles की संख्या की सीमा शामिल है, तो X का आंतरिक system Engagement API के माध्यम से query किए गए पोस्ट्स के मालिक Authenticated users की संख्या का रिकॉर्ड रखेगा। ग्राहकों को client side पर भी इस unique संख्या का रिकॉर्ड रखना चाहिए। वर्तमान में, Engagement API के लिए @handle उपयोग जाँचने हेतु कोई usage API या UI उपलब्ध नहीं है। यदि contract में तय संख्या से अधिक @handles का अनुरोध किया जाता है, तो system overage को block नहीं करेगा। billing month के अंत में, query किए गए unique @handles की संख्या की तुलना contract की गई मात्रा से की जाती है और contract की शर्तों के अनुसार overage charge किया जाएगा।
क्या मैं Engagement API के लिए अपना @handle उपयोग जाँच सकता/सकती हूँ?
क्या मैं Engagement API के लिए अपना @handle उपयोग जाँच सकता/सकती हूँ?
वर्तमान में, Engagement API के लिए @handle उपयोग जाँचने हेतु कोई usage API या UI उपलब्ध नहीं है। यदि contract में तय संख्या से अधिक @handles का अनुरोध किया जाता है, तो system overage को block नहीं करेगा। billing month के अंत में, query किए गए unique @handles की संख्या की तुलना contract की गई मात्रा से की जाती है और contract की शर्तों के अनुसार overage charge किया जाएगा।payload में लौटाया गया
engagements metadata field सभी अलग-अलग engagement metric totals के योग के बराबर नहीं है। ऐसा क्यों है?यह अपेक्षित है। engagements metadata field हमेशा API द्वारा लौटाए गए सभी individual engagement metrics के कुल योग से मेल नहीं खा सकता। ऐसा इसलिए है क्योंकि engagements metadata field में ऐसे अतिरिक्त engagements शामिल हो सकते हैं जिनके लिए payload में अलग से कोई विशिष्ट metrics नहीं दिए गए होते। दूसरे शब्दों में, अलग-अलग engagement metric totals को जोड़ने पर जो मान मिलता है, वह ज़रूरी नहीं कि payload में लौटाए गए engagements metric field के मान के बराबर हो।आप engagements metadata field को पोस्ट पर किए गए किसी भी click या interaction के रूप में समझ सकते हैं।
payload response में url_clicks field एक संख्या लौटा रहा है, जबकि वास्तव में पोस्ट में कोई URL नहीं है। यह कैसे संभव है?ऐसा इसलिए हो सकता है कि किसी पोस्ट में hashtag जैसी कोई चीज़ हो, जो किसी दूसरे page का link बनाती है। यदि कोई user उस पर click करता है, तो उसे URL click के रूप में गिना जाएगा।
मैं किसी विशिष्ट पोस्ट के लिए engagement data क्यों प्राप्त नहीं कर सकता/सकती?
मैं किसी विशिष्ट पोस्ट के लिए engagement data क्यों प्राप्त नहीं कर सकता/सकती?
किसी विशिष्ट पोस्ट के लिए engagement data प्राप्त न कर पाने के कई कारण हो सकते हैं, जिनमें शामिल हैं:
- आपके द्वारा अनुरोधित Post ID या IDs उस authentication token के आधार पर उपलब्ध नहीं हैं, जिसका उपयोग आप किसी third party की ओर से data प्राप्त करने के लिए कर रहे हैं।
- /totals endpoint के लिए आपके द्वारा अनुरोधित Post ID या IDs 90 दिन पुराने या उससे कम पुराने नहीं हैं, इसलिए impressions या engagement metrics लौटाने के लिए उपलब्ध नहीं हैं।
- आपके द्वारा अनुरोधित Post ID या IDs अब उपलब्ध नहीं हैं, जो आमतौर पर यह दर्शाता है कि उन्हें delete कर दिया गया है या किसी अन्य कारण से वे अब publicly available नहीं हैं।
मैं Engagement API के साथ rate limiting को कैसे handle कर सकता/सकती हूँ?
मैं Engagement API के साथ rate limiting को कैसे handle कर सकता/सकती हूँ?
Engagement API को request भेजते समय अपने consumption की निगरानी करने के लिए आप response header में लौटाई गई
x-per-minute-limit और x-per-minute-remaining जानकारी का उपयोग कर सकते हैं।x-per-minute-limit बताता है कि आपकी allowance क्या है, और x-per-minute-remaining बताता है कि आपके पास कितनी calls बची हैं।मुझे प्रमाणित होने में समस्या आ रही है
मुझे प्रमाणित होने में समस्या आ रही है
कृपया Engagement API के साथ प्रमाणीकरण संबंधी हमारे दिशानिर्देश देख लें।
मैंने सही consumer key और secret, साथ ही access token और access token secret दिए हैं, लेकिन फिर भी नीचे दी गई त्रुटि लौट रही है। मैं क्या करूँ?
मैंने सही consumer key और secret, साथ ही access token और access token secret दिए हैं, लेकिन फिर भी नीचे दी गई त्रुटि लौट रही है। मैं क्या करूँ?
मेरे पास एक ऐसा प्रश्न है जिसका अभी तक उत्तर नहीं दिया गया है
मेरे पास एक ऐसा प्रश्न है जिसका अभी तक उत्तर नहीं दिया गया है
कृपया तकनीकी सहायता से संपर्क करें और हम आपको शीघ्र जवाब देंगे।
Engagement API में HTTPS का उपयोग आवश्यक है और यह User Context तथा Application-Only OAuth, दोनों का समर्थन करता है। Engagement API के लिए अधिकांश अनुरोधों में 3-Legged OAuth (User Context का एक विशिष्ट संस्करण) का उपयोग करना आवश्यक होता है। इसका मतलब है कि आप उस ऐप की consumer key और secret का उपयोग करते हैं, जिसे आपके Twitter account manager ने Engagement API access के लिए पंजीकृत और स्वीकृत किया है। साथ ही, endpoint को कॉल करने के लिए Tweet मालिकों के access token और access token secret का भी उपयोग किया जाता है। निम्नलिखित अनुरोधों के लिए इस प्रकार के OAuth की आवश्यकता होती है:
- Impressions और Engagements मेट्रिक प्रकार प्राप्त करने के लिए /totals पर कोई भी अनुरोध, जो केवल आपके स्वामित्व वाले Tweets तक सीमित हैं
- /28hr पर कोई भी अनुरोध
- /historical पर कोई भी अनुरोध
- Favorites, Replies, Retweets, या Video Views मेट्रिक प्रकार प्राप्त करने के लिए /totals पर कोई भी अनुरोध, जिन्हें किसी भी Tweet के लिए प्राप्त किया जा सकता है
- OAuth अवलोकन
- 3 Legged OAuth का उपयोग, जिसे User Context भी कहा जाता है
- Application-Only OAuth का उपयोग
28 hour endpoint पिछले 28 घंटों के लिए अधिकतम 25 Tweets के संग्रह के impressions और engagements प्राप्त करने की सुविधा देता है। 28 hour endpoint सभी समर्थित individual metrics के लिए metrics का अनुरोध करने की सुविधा भी देता है। समर्थित metrics की पूरी सूची के लिए Metric Availability देखें।
historical endpoint 4 सप्ताह तक की किसी भी अवधि के लिए अधिकतम 25 Tweets के संग्रह की impressions और engagements प्राप्त करने की सुविधा देता है। वर्तमान में, 1 सितंबर 2014 से पुराने डेटा का अनुरोध API से नहीं किया जा सकता। historical endpoint सभी समर्थित individual metrics के लिए metrics का अनुरोध करने की सुविधा भी देता है। समर्थित metrics की पूरी सूची के लिए Metric Availability देखें।
विभिन्न परिस्थितियों में, Engagement API प्रसंग-विशिष्ट त्रुटि संदेश लौटा सकता है, जिनसे निपटने के लिए आपके एप्लिकेशन को तैयार होना चाहिए। नीचे दी गई तालिका में इन त्रुटि संदेशों के सामान्य उदाहरण और उनकी व्याख्या करने का तरीका दिया गया है। कृपया ध्यान दें कि कई मामलों में Engagement API, अधिक जानकारी के साथ 200 OK response के हिस्से के रूप में, उपलब्ध data के लिए विशिष्ट त्रुटि संदेशों सहित आंशिक परिणाम लौटाता है।