API Hop

दस्तावेज़

API Hop दस्तावेज़

SimilarwebAPI गाइड

प्रमाणित REST एंडपॉइंट से वेबसाइट ट्रैफ़िक, खोज कीवर्ड, बैकलिंक, रेफ़रल, प्रतिस्पर्धी और सहभागिता क्वेरी करें।

SimilarwebAPI, /v1/similarweb के अंतर्गत 27 केवल-पढ़ने वाले डेटा एंडपॉइंट देता है। दूसरे API Hop API वाला खाता, API कुंजी, शेष राशि और उपयोग इतिहास ही इस्तेमाल करें। उपलब्धता चालू गेटवे और API कुंजी अनुमतियों पर निर्भर है; दस्तावेज़ प्रोडक्शन उपलब्धता की पुष्टि नहीं करता।

प्रमाणीकरण

अपनी API Hop API कुंजी भेजें, तीसरे पक्ष का क्रेडेंशियल नहीं:

http
Authorization: Bearer YOUR_API_KEY

अनुरोध उदाहरण

सभी सार्वजनिक ऑपरेशन बिना अनुरोध बॉडी के क्वेरी पैरामीटर सहित GET लेते हैं। पथ और पैरामीटर का अक्षर-केस दस्तावेज़ जैसा ही रखें।

केवल विश्वव्यापी डेटा समर्थित है (country=999)। अन्य वैध देश मान अपस्ट्रीम अनुरोध से पहले 999 में बदलते हैं और देश-विशिष्ट के बजाय विश्वव्यापी डेटा लौटाते हैं।

तारीख स्वीकार करने वाले एंडपॉइंट में वैध, पूरी, स्पष्ट from/to सीमा को प्राथमिकता है। latest स्वीकार करने वाले एंडपॉइंट में दिया मान मौजूदा प्रारूप और एंडपॉइंट-विशिष्ट सत्यापन से गुजरता है, लेकिन सीमा चयन में अनदेखा होता है और Similarweb को नहीं भेजा जाता; डिफ़ॉल्ट latest नहीं जोड़ा जाता। स्पष्ट सीमा न हो तो मौजूदा latest, डिफ़ॉल्ट और विंडो व्यवहार अपरिवर्तित है। इतिहास प्रतिबंध लागू रहते हैं और latest न स्वीकार करने वाले एंडपॉइंट उसे अब भी अस्वीकार करते हैं।

bash
curl --get "https://api.apihop.ai/v1/similarweb/websites/incoming-referrals" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  --data-urlencode "key=example.com" \
  --data-urlencode "country=999" \
  --data-urlencode "page=1"

आने वाले रेफ़रल में एक छोटे अक्षर वाला key होस्टनाम है, keys नहीं। यह key लक्ष्य वेबसाइट का व्यावसायिक क्वेरी पैरामीटर है, API क्रेडेंशियल नहीं; केवल विशेष अनुमति-सूची वाले Similarweb GET रूट पर अनुमत है। API प्रमाणीकरण में अब भी Authorization है और अन्य क्रेडेंशियल क्वेरी फ़ील्ड प्रतिबंधित हैं। इसकी पंक्तियाँ Records में आती हैं, Data में नहीं। हर ऑपरेशन के सही फ़ील्ड के लिए पूरा एंडपॉइंट संदर्भ देखें।

कवरेज

  • खोज: कीवर्ड सुझाव, रैंक वाले पृष्ठ, वेबसाइट कीवर्ड, ऑर्गेनिक और सशुल्क खोज, ब्रांडेड कीवर्ड।
  • वेबसाइट ट्रैफ़िक: सहभागिता, विज़िट, भूगोल, डिवाइस मिश्रण, चैनल और सोशल ट्रैफ़िक।
  • संबंध: बैकलिंक, आने वाले रेफ़रल, बाहर जाने वाला ट्रैफ़िक और समान वेबसाइट।
  • इतिहास: मासिक विज़िट, बाउंस दर, विज़िट अवधि और प्रति विज़िट पृष्ठों की अलग श्रृंखलाएँ।

उत्तर

सफल उत्तर बिना नए success/data आवरण के मूल JSON बॉडी रखते हैं। फ़ील्ड नाम, अज्ञात फ़ील्ड, खाली ऐरे और संख्यात्मक सटीकता अपरिवर्तित हैं। अलग एंडपॉइंट Data, Records या अन्य मूल संरचना लौटा सकते हैं; एक सार्वभौमिक पंक्ति फ़ील्ड न मानें।

खाली सफल परिणाम का अर्थ डोमेन में ट्रैफ़िक नहीं है होना नहीं। विफल अनुरोध को खाली डेटा न मानें। निदान के लिए X-Request-Id और अनुरोध समय रखें।

बिलिंग और पृष्ठांकन

सभी 27 एंडपॉइंट की मानक कीमत प्रति सफल अनुरोध $0.0005 या प्रति 1,000 अनुरोध $0.50 है। बिलिंग प्रति अनुरोध है, प्रति पंक्ति नहीं; सफल खाली परिणाम भी एक अनुरोध गिना जाता है। हर अगला पृष्ठ अलग अनुरोध है। कॉन्फ़िगर होने पर खाते की विशिष्ट कीमत को प्राथमिकता है। अमान्य पैरामीटर, अनुपस्थित प्रमाणीकरण या अपर्याप्त शेष राशि वाले अनुरोध सफल बिल योग्य कॉल नहीं बनते। विफल अपस्ट्रीम अनुरोधों पर शुल्क नहीं लगता।

प्लेटफ़ॉर्म की न्यूनतम शेष राशि नीति के अनुसार कॉल से पहले खाते में कम-से-कम $0.10 उपलब्ध होना चाहिए। मानक शुल्क प्रति सफल अनुरोध $0.0005 ही रहता है।

केवल चुने एंडपॉइंट के दस्तावेज़ीकृत पृष्ठांकन फ़ील्ड दें। पृष्ठांकन आम तौर पर 1 से शुरू होता है; बैकलिंक में Page और PageSize, जबकि दूसरी तालिकाओं में page, pageSize या rowsPerPage हो सकते हैं। असमर्थित पृष्ठ-आकार फ़ील्ड न भेजें।

त्रुटियाँ

प्लेटफ़ॉर्म त्रुटियाँ नीचे की संरचना लेती हैं; code प्लेटफ़ॉर्म व्यावसायिक कोड है, HTTP स्थिति नहीं:

json
{"success":false,"error":{"code":10000,"message":"Invalid request parameters"},"requestId":"..."}

सामान्य HTTP स्थितियाँ हैं: 400 अमान्य क्वेरी, 401 अमान्य API कुंजी, 402 अपर्याप्त शेष राशि, 403 गेटवे पहुँच अस्वीकृत, 429 दर सीमा और 5xx अस्थायी अपस्ट्रीम या सेवा विफलता। गलत प्रारूप वाला अनुरोध बिना बदले दोबारा न भेजें।