Skip to main content

Prospect Portals

Create branded, shareable links that let external users — prospects, clients, partners — explore your mock API simulations without a SureStage account. Optionally gate access behind email registration and track engagement analytics.

Overview​

Prospect Portals are designed for:

  • Sales Engineers sharing API demos with prospects
  • Solutions teams providing sandboxed API exploration to clients
  • Partnerships giving integration partners a preview of your mock environment
Feature Flag

This feature requires the growth_prospect_portals feature flag to be enabled.

Creating a Portal​

  1. Click Portals in the sidebar
  2. Click Create Portal
  3. Fill in four sections:

Basic Info​

  • Name (required) — descriptive name (e.g., "Acme Corp Demo Portal")
  • Description (optional) — context for you and teammates

Simulation Selection​

  • Check the simulations to include in the portal
  • At least one simulation is required
  • Only simulations you own are shown

Branding​

  • Company Name — displayed in the portal header
  • Welcome Message — greeting text for visitors
  • Primary Color — hex color for the portal accent
  • Logo URL — URL to your company logo

Access Settings​

  • Require Email toggle — when enabled, visitors must register their email before viewing simulations
  • Expiry Date (optional) — the portal auto-deactivates after this date
  1. Click Create Portal

After creating a portal, the Portal Link Created screen shows:

  • The shareable URL
  • A Copy button with visual confirmation
  • An Open Portal link to preview in a new tab

Share the URL via email, Slack, or any channel. No SureStage login required.

Managing Portals​

The Portals Dashboard shows a grid of all your portals:

ColumnDescription
NamePortal name
StatusActive (green) or Inactive (gray)
ViewsTotal page views
Unique VisitorsDistinct visitor count
Last VisitedMost recent access
CreatedCreation date

Per-Portal Actions​

  • Active/Inactive toggle — instantly enable or disable without deleting
  • Open Portal — preview the public URL
  • Revoke — permanently deactivate (soft delete)

Engagement Analytics​

Click any portal card to open the Engagement Detail page:

Summary Cards​

  • Total Views — cumulative page loads
  • Unique Visitors — distinct visitors by email or token
  • Last Visited — most recent visit timestamp

Top Visitors​

A ranked list showing:

  • Identity (email or "Anonymous")
  • First and last visit dates
  • Total API requests
  • Unique endpoints explored

Endpoint Heatmap​

An accessible table showing which endpoints were explored most:

ColumnDescription
EndpointRoute path (e.g., /api/users)
MethodHTTP method badge (GET, POST, PUT, DELETE)
RequestsTotal request count
Unique VisitorsDistinct visitors for this endpoint
IntensityHeat indicator (Very Low to Very High)

The Visitor Experience​

Without Email Gate​

  1. Branded landing page with your logo, company name, and welcome message
  2. Grid of included simulations with name, description, and endpoint count
  3. Click a simulation to explore its API documentation

With Email Gate​

  1. Branded landing page
  2. Email registration form
  3. After registering, the visitor receives a session token
  4. Simulation grid becomes accessible
  5. Refreshing the page does not re-prompt (token persists in browser session)

Portal Lifecycle​

  • Inactive portals return "Portal not found" to visitors
  • Expired portals return "Portal has expired"
  • Revoked portals cannot be reactivated

Limitations​

  • Visitor tokens are session-scoped — closing the browser requires re-registration
  • Portal engagement tracking is fire-and-forget — occasional dropped events under heavy load are possible
  • Only simulation owners can create portals

Next Steps​