API Hop

เอกสาร

เอกสาร API Hop

SimilarwebAPI

>-

SimilarwebAPI มีเอนด์พอยต์ข้อมูลอ่านอย่างเดียว 27 รายการใต้ /v1/similarweb ใช้บัญชี คีย์ API ยอดคงเหลือ และประวัติใช้งานเดียวกับ API อื่นของ API Hop ความพร้อมขึ้นกับเกตเวย์ที่เปิดใช้และสิทธิ์คีย์ API เอกสารไม่ยืนยันความพร้อมในระบบจริง

การยืนยันตัวตน

ส่งคีย์ API ของ API Hop ไม่ใช่ข้อมูลรับรองบุคคลที่สาม:

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 อนุญาตเฉพาะเส้นทาง GET ของ Similarweb ที่ระบุไว้ การยืนยันตัวตน API ยังใช้ Authorization และห้ามฟิลด์คิวรีข้อมูลรับรองอื่น แถวส่งใน Records ไม่ใช่ Data ดูเอกสารเอนด์พอยต์ฉบับเต็ม สำหรับฟิลด์ที่ตรงของแต่ละการดำเนินการ

ความครอบคลุม

  • ค้นหา: คำหลักแนะนำ หน้าจัดอันดับ คำหลักเว็บไซต์ การค้นหาธรรมชาติและเสียเงิน คำหลักแบรนด์
  • ทราฟฟิกเว็บไซต์: การมีส่วนร่วม การเข้าชม ภูมิศาสตร์ สัดส่วนอุปกรณ์ ช่องทาง และทราฟฟิกโซเชียล
  • ความสัมพันธ์: ลิงก์ย้อนกลับ การอ้างอิงขาเข้า ทราฟฟิกขาออก และเว็บไซต์คล้ายกัน
  • ประวัติ: ชุดข้อมูลรายเดือนแยกสำหรับการเข้าชม อัตราตีกลับ ระยะเวลาเข้าชม และหน้าต่อการเข้าชม

การตอบกลับ

การตอบกลับสำเร็จคงเนื้อหา JSON ดั้งเดิมโดยไม่เพิ่มตัวครอบ success/data ชื่อฟิลด์ ฟิลด์ไม่รู้จัก อาร์เรย์ว่าง และความแม่นยำตัวเลขไม่เปลี่ยน เอนด์พอยต์ต่างกันอาจส่ง Data, Records หรือรูปแบบดั้งเดิมอื่น อย่าคิดว่ามีฟิลด์แถวสากล

ผลสำเร็จว่างไม่ได้หมายความว่าโดเมนไม่มีทราฟฟิก ห้ามถือคำขอล้มเหลวเป็นข้อมูลว่าง เก็บ X-Request-Id และเวลาคำขอเพื่อแก้ปัญหา

การคิดค่าบริการและแบ่งหน้า

ราคามาตรฐานคือ $0.0005 ต่อคำขอสำเร็จ หรือ $0.50 ต่อ 1,000 คำขอ สำหรับทั้ง 27 เอนด์พอยต์ คิดต่อคำขอ ไม่ใช่ต่อแถว ผลว่างสำเร็จยังนับหนึ่งคำขอ หน้าถัดไปแต่ละหน้าเป็นคำขอแยก ราคาประจำบัญชีมีผลก่อนเมื่อกำหนดไว้ คำขอพารามิเตอร์ไม่ถูกต้อง ขาดสิทธิ์ หรือยอดไม่พอไม่ดำเนินเป็นการเรียกสำเร็จที่คิดค่าบริการ คำขอต้นทางล้มเหลวไม่คิดค่าบริการ

บัญชีต้องมียอดพร้อมใช้อย่างน้อย $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 ต้นทางหรือบริการล้มเหลวชั่วคราว อย่าลองคำขอรูปแบบผิดซ้ำโดยไม่แก้