Skip to content

embed.mdx

Latest commit

 

History

History
78 lines (60 loc) · 2.71 KB

embed.mdx

File metadata and controls

78 lines (60 loc) · 2.71 KB
Raw
icon embed
title Embed Widget
sidebarTitle Embed
description Embed ChainPatrol's threat protection metrics on your website
unlisted true

The ChainPatrol Embed Widget allows you to display your organization's threat protection metrics directly on your website. This widget provides real-time updates on your security metrics and can be customized to match your website's theme.

Usage

To embed the widget on your website, use an iframe with the following URL structure:

<iframe
  src="https://embed.chainpatrol.io/?slug=YOUR_ORGANIZATION_SLUG&theme=dark"
  width="1000"
  height="400"
  frameborder="0"
  style="border: none;"
></iframe>

Parameters

The widget accepts the following URL parameters:

Parameter Description Default Options
slug Your organization's unique identifier none your org slug
theme The color theme of the widget dark light, dark, transparent
width The width of the widget 1000px Any valid CSS width value

Example URLs

  • Default dark theme: https://embed.chainpatrol.io/?slug=chainpatrol&theme=dark
  • Light theme: https://embed.chainpatrol.io/?slug=chainpatrol&theme=light
  • Transparent background: https://embed.chainpatrol.io/?slug=chainpatrol&theme=transparent
  • Custom width: https://embed.chainpatrol.io/?slug=chainpatrol&theme=dark&width=800px
  • 30-day metrics: https://embed.chainpatrol.io/?slug=chainpatrol&theme=dark&timeRange=30d

Metrics Displayed

The widget displays the following metrics:

  • Total Reports
  • Total Threats
  • Takedowns Filed
  • Takedowns Completed
  • Domain Threats
  • Twitter Threats
  • Telegram Threats
  • Other Threats

Styling

The widget automatically adapts to your website's theme based on the theme parameter:

![Dark Theme](/images/embed-dark.png) ![Light Theme](/images/embed-light.png) ![Transparent Theme](/images/embed-transparent.png)
  • light: White background with dark text
  • dark: Dark background with light text
  • transparent: Transparent background that blends with your website

Security

The embed widget is served over HTTPS and includes security headers to prevent clickjacking and other common web vulnerabilities. The widget only displays publicly available metrics and does not expose any sensitive information.