API Reference

Ghost ID provides a REST API for programmatic access to your analytics data. All endpoints require authentication via session cookie.

🔑 Authentication

Ghost ID uses session-based authentication. Sign in to Ghost ID in your browser, then send requests with the same active session cookie. No separate API token is required for the endpoints documented here.

ℹ️

Requests made without a valid session cookie return an authentication error or an empty result set depending on the endpoint.

🌐 Base URL

Text

https://analytics.ghostid.ai

🧪 Example

Bash

curl --request GET \
  --url https://analytics.ghostid.ai/api/sites \
  --cookie "session=YOUR_SESSION_COOKIE"

📖 Reference Sections

Profile & Account

Retrieve your profile, update name and email, change password, and delete your account.

Sites

Create, update, list, and remove sites tied to your Ghost ID account.

Visitors

Stream live activity, browse scored visitors, and fetch full visitor profiles.

Events & Tracking

Read dashboard stats and inspect full session timelines.

Links

Manage tracking links, validate slugs, and review click analytics.

Revenue

Pull attributed revenue summaries, campaigns, transactions, and daily trends.

Webhooks

Export visitor data to external systems with formatted webhook payloads.

Identify

Attach known identity data to a visitor and retrieve the current identity record.

Revenue Connections

Profile & Account