Documentation

HiveSense — HTTP APIs & discovery

Find conversion blockers, AOV opportunities, checkout friction, and revenue leaks on Shopify storefronts with fast, action-ready audits.

Discovery (no auth)

Public-ish API routes

These are invoked by the browser or documented for automation. They do not constitute a fully public, versioned merchant API unless noted.

  • POST https://hivesense.co/api/trial-job

    Start a homepage trial audit. Requires an anonymous session cookie; Turnstile when configured in production.

  • GET https://hivesense.co/api/jobs/{jobId}/status

    Poll job status when the visitor owns an anonymous stray/trial job. Other cases require signing in with workspace access.

  • POST https://hivesense.co/api/runner/webhook

    Internal webhook for the audit runner — secured with a shared secret.

Authenticated workspace APIs

Routes under /api/projects, /api/teams, /api/billing, and most of /api/jobs/… require an active NextAuth session and appropriate workspace permissions.

← Back to site