Skip to main content

52 docs tagged with "api"

View all tags

Alerts

Create alert rules for traffic anomaly detection with email, Slack, or webhook notifications, plus alert history and statistics

API FAQ

Answers to common API integration questions — account_id vs site_id, event-level conversions, JWT scopes, and working /exports/stream examples.

API Overview

REST API reference for Sealmetrics — query analytics stats and manage sites, exports, and alerts with API key or JWT authentication

API Tokens

Create and manage read-only personal API tokens with scoped permissions, optional account restrictions, and automatic expiration

API v1 to v2 Migration

Guide for data analysts moving from the legacy Sealmetrics API v1.0 (Postman collection) to the current REST API — host, auth, pagination, and endpoint-by-endpoint mapping.

Audit Logs

Query the audit trail of mutating actions across your organization, filterable by action type, resource, author, and date range

Auth Advanced

Session management, password reset, and two-factor authentication reference — list active sessions and terminate them per device

Authentication

How to authenticate with the Sealmetrics API using read-only API keys (X-API-Key header) or JWT bearer tokens from login

Batch API

Execute multiple analytics queries in one HTTP request with dependency ordering, parallel limits, and per-query timing options

BigQuery Integration

Sync Sealmetrics analytics to Google BigQuery with hourly or daily schedules, backfill options, and BI tool integration

Billing API

Manage plans, subscriptions, invoices, usage, coupons, and the Seal AI Private add-on through the cookie-authenticated billing proxy

Bot Stats

Inspect bot detection signals — suspicion score distribution, top flag reasons, daily trends, and drill-down into suspicious sessions

Bypass POS or Referrer

Learn how to exclude payment gateways and external domains from being counted as referrers in Sealmetrics.

Channel Groups

Manage GA4-style channel classification rules that match utm_source, medium, and campaign via regex with priority ordering

Email Reports

Schedule daily, weekly, or monthly email reports with selectable sections and delivery at a fixed hour in a chosen timezone

Email Verification

Endpoints for the post-registration email confirmation flow — check status, resend the verification email, and verify with auto-login

Error codes

Every error code the Sealmetrics API can return, with its HTTP status, what it means, and whether the request is safe to retry.

Exports

Create and download bulk exports of analytics data in CSV or JSON, covering pages, sources, conversions, devices, and time series

Features

Explore the complete feature set of Sealmetrics - from core analytics reports to API access, conversion tracking, and privacy-first capabilities.

For AI Agents

Everything an AI agent or LLM tool needs to use the Sealmetrics API — OpenAPI spec, hosted MCP server, OAuth 2.1, batch queries, async export jobs, rate-limit headers and error codes, on one page.

IP Allowlist

Restrict API and dashboard access to allowed IPs or CIDR ranges, with bulk import/export and audit logging (Enterprise plans)

IP Blocklist

Block individual IPs or CIDR ranges from tracking to exclude internal traffic, known bots, competitors, or test infrastructure

LENS API Endpoints

REST API reference for LENS: insights, settings and usage, weekly and monthly reports, and AI assistant chat endpoints with Bearer authentication.

LLM Settings (BYOK)

Manage per-user Bring-Your-Own-Key LLM configs for LENS AI — store, test, and set default keys for OpenAI, Anthropic, Gemini, or DeepSeek

MCP Server for AI Assistants

Connect Claude, ChatGPT, Cursor, Codex, and other AI assistants to your SealMetrics analytics using the Model Context Protocol (MCP) — either the hosted remote server (one URL, no install) or the local npx server.

Multi-Dimensional Query

Flexible query endpoint to cross any combination of dimensions and metrics. Ideal for custom reports, data warehouses, and BigQuery exports.

Multi-Site Aggregate Stats

Portfolio-level analytics — aggregate traffic, conversions, pages, sources, geo, and devices across multiple sites in a single query

OAuth 2.1

Connect a third-party app or AI assistant to someone else's Sealmetrics account using OAuth 2.1 — discovery metadata, dynamic client registration, authorization code with PKCE, refresh tokens and revocation.

Organization Invitations

Public endpoints for accepting organization invitations — the token is the credential, with auto-login for newly created users

Organizations

Manage organizations, team members, roles, invitations, and site-level access in the SealMetrics multi-tenancy model

Pagination & Filtering

Reference for pagination, sorting, and advanced filters across API endpoints, including page_size limits and consistent response format

Passthrough Referrers

Register booking engines, payment gateways, and other domains that preserve session attribution instead of creating a new referral

Period Comparison

Compare analytics between time periods with the compare parameter — previous period or year-over-year deltas on any stats endpoint

Provisioning (headless signup)

Create a free-tier Sealmetrics account from code with POST /provision — no card, no dashboard login, no browser. Built for AI agents and installers.

Python SDK (unreleased)

Design reference for the Sealmetrics Python SDK — not yet published to PyPI. Use the OpenAPI spec, the REST API or the MCP server today.

Quick Start

Get your first Sealmetrics API call working in 5 minutes — generate a token, find your Site ID, and pull traffic data via REST in three steps.

Rate Limits

Per-plan API rate limits, X-RateLimit response headers, and 429 handling with the Retry-After header when the limit is exceeded

Referrer Mappings

Map referrer domains to UTM values so untagged partner and vendor traffic is attributed correctly, with priority-ordered matching rules

Referrer Mappings

Learn how to map known referrer domains to specific source, medium, and campaign values so traffic from partners, affiliates, or internal domains is attributed correctly in SealMetrics.

Saved Pixels

Save reusable pixel configurations for pageviews, conversions, and microconversions, then generate install code for JavaScript, GTM, or Tealium

Segments

Create reusable saved filter configurations, apply them consistently across all analytics endpoints, and share segments with your team

Shared Dashboards

Create public or password-protected shareable dashboards with share tokens, embed configs, allowed domains, and expiration dates

Sites

Create and manage analytics sites, configure authorized domains and UTM mappings, and generate and verify pixel installation

Stats Advanced

Advanced analytics endpoints for the UTM hierarchy — mediums, sources, campaigns, terms — plus landing pages, channels, and microconversions

Stats Endpoints

Analytics data endpoints for retrieving traffic, conversion, and engagement metrics.

Subscription Status

Check an organization's subscription state — plan tier, trial end, billing period, and paywall block status from a single endpoint

Tracker API Reference

Complete API reference for the SealMetrics JavaScript tracker. Includes all methods, parameters, and payload specifications.

Two-Factor Authentication

Manage the user's TOTP-based second factor — enable, verify at login, disable, and regenerate backup codes.

Users

Manage the current user's profile and password via /users/me — most other user CRUD endpoints are superadmin-only

Webhooks

Receive real-time HTTP callbacks for alerts and export events, signed with HMAC-SHA256 and retried up to 5 attempts on failure

Webhooks

Send real-time Sealmetrics events to your own services via HTTP callbacks, configured through the API.