REST API

NowMetrix का डेटा अपनी टीम के पहले से इस्तेमाल किए जा रहे टूल्स में लाएँ।

लाइव स्नैपशॉट से शुरुआत करें, न्यूज़रूम डिस्प्ले बनाएँ या ऐतिहासिक परिणाम अपनी रिपोर्टिंग प्रक्रिया में भेजें। यहाँ कोई एंडपॉइंट चुनें और उसका पूरा तकनीकी संदर्भ खोलें।

अपना एप्लिकेशन कनेक्ट करें

क्या आप API का पहली बार इस्तेमाल कर रहे हैं? पूरी कनेक्शन गाइड से शुरुआत करें। इसमें API कुंजी बनाने और सुरक्षित रखने, /api/me से उसे सत्यापित करने और आम प्रोग्रामिंग भाषाओं से उसी प्रमाणित अनुरोध को भेजने का तरीका बताया गया है।

कनेक्शन गाइड खोलें

एक बेस URL से शुरुआत करें

API कुंजी से प्रमाणित हर अनुरोध इस होस्ट से शुरू होता है:

https://api.nowmetrix.com

अपनी API कुंजी भेजें

Authorization हेडर में API कुंजी को Bearer टोकन के रूप में भेजें। अकाउंट एडमिन और API एक्सेस वाले टीम सदस्य, NowMetrix डैशबोर्ड में सेटिंग्स -> API के अंतर्गत अधिकतम 10 सक्रिय कुंजियाँ बना और उन्हें नाम दे सकते हैं।

Authorization: Bearer nm_YOUR_KEY

HTTPS ज़रूरी है। सभी कुंजियों को उनके NowMetrix उपयोगकर्ता की अनुमतियाँ मिलती हैं और वे प्रत्येक ट्रैकर की अनुरोध सीमा साझा करती हैं।

अपना पहला अनुरोध करें

अपना सेटअप जाँचने का सबसे तेज़ तरीका रीयलटाइम स्नैपशॉट लेना है। इससे पुष्टि हो जाती है कि कुंजी काम कर रही है और ट्रैकर तक पहुँच उपलब्ध है।

curl -H "Authorization: Bearer nm_YOUR_KEY" \
  "https://api.nowmetrix.com/v1/realtime?site=TRACKER_ID"

अपनी ज़रूरत का डेटा चुनें

विधि पाथ विवरण संदर्भ
GET /v1/realtime वर्तमान लाइव स्नैपशॉट: सक्रिय उपयोगकर्ता, पेजव्यू, शीर्ष पेज, डिवाइस, देश, शहर और स्रोत। एंडपॉइंट देखें
GET /v1/sources वर्तमान लाइव विंडो से मिले ट्रैफ़िक स्रोत, वर्गीकरण और वैकल्पिक चाइल्ड रो के साथ। एंडपॉइंट देखें
GET /v1/overview इतिहास की पिछली N पूरी हो चुकी रो के लिए दैनिक पेजव्यू और विज़िट। एंडपॉइंट देखें
GET /v1/recap प्रीसेट या कस्टम तारीख़ सीमा के लिए Recap डेटा, सारांश मेट्रिक्स और शीर्ष पेज। एंडपॉइंट देखें
GET /v1/pulse आज का Pulse, कल की तुलना और 15-मिनट के दिन के भीतर के कर्व। एंडपॉइंट देखें
GET /v1/proofreading एक ट्रैकर के हाल में जाँचे गए लेखों से वर्तमान में दिखाई दे रहे अधिकतम 100 टेक्स्ट जाँच सुझाव। एंडपॉइंट देखें
GET /v1/responsibilities किसी ट्रैकर की वर्तमान टीम ज़िम्मेदारियाँ, जिसमें दिखाई देने वाली हर भूमिका के लिए नियुक्त व्यक्ति शामिल है। एंडपॉइंट देखें
GET /api/me API कुंजी से जुड़े अकाउंट का संदर्भ: वर्तमान ट्रैकर और वे सभी ट्रैकर जिन तक टोकन पहुँच सकता है। एंडपॉइंट देखें

अनुरोध तेज़ और पूर्वानुमानित रखें

सार्वजनिक API हर ट्रैकर के लिए प्रति मिनट 20 अनुरोधों की अनुमति देती है। एक ही ट्रैकर को क्वेरी करने वाले कई उपयोगकर्ता या कुंजी एक ही काउंटर साझा करते हैं।

X-RateLimit-Limit: 20
X-RateLimit-Remaining: 7
X-RateLimit-Reset: 1783612801
Retry-After: 42
जब भी संभव हो, API प्रतिक्रियाओं को अपने सिस्टम में कैश करें। सामान्य नियम के तौर पर, रीयलटाइम डेटा को थोड़े समय के लिए और ऐतिहासिक overview डेटा को कई मिनटों के लिए कैश करें।

जब कोई अनुरोध विफल हो

हर समस्या के लिए अलग फ़ॉर्मैट पार्स करने की ज़रूरत नहीं होनी चाहिए। API त्रुटियों में एक समान JSON बॉडी और स्थिर मशीन-पठनीय code होता है।

HTTP Code विवरण
400 site_required ज़रूरी site पैरामीटर मौजूद नहीं है।
401 missing_token Authorization हेडर मौजूद नहीं है।
401 invalid_token टोकन अमान्य है या रद्द कर दिया गया है।
403 site_not_authorized API कुंजी को इस ट्रैकर की पहुँच नहीं है।
429 rate_limit_exceeded अनुरोधों की निर्धारित सीमा पार हो गई है।
503 redis_unavailable रीयलटाइम बैकएंड अस्थायी रूप से उपलब्ध नहीं है। 
{
  "error": {
    "code": "invalid_token",
    "message": "Bearer token is invalid or revoked."
  }
}