API Reference / Endpoints

Log View

The Log View endpoint allows you to record when a visitor views your waitlist. This helps you track engagement and calculate conversion rates for your waitlist.

Endpoint Details

  • URL: https://waitlister.me/api/v1/waitlist/{waitlist-key}/log-view
  • Method: POST
  • Required Plan: Pro or Scale

Request

Headers

Content-Type: application/json
X-Api-Key: your-api-key

Path Parameters

ParameterDescription
waitlist-keyYour unique waitlist key, found in your waitlist settings

Request Body

{
  "visitor_id": "unique-visitor-id",
  "metadata": {
    "referring_domain": "google.com"
  }
}

Optional Fields

FieldTypeDescription
visitor_idStringA unique identifier for the visitor to prevent duplicate view counts
metadataObjectAdditional information about the view
metadata.referring_domainStringDomain that referred the view (overrides HTTP referrer)

Response

Success Response 200

{
  "success": true,
  "message": "Successfully logged view"
}

Success Response Fields

FieldTypeDescription
successBooleanAlways true for successful responses
messageStringA human-readable success message

Error Responses

Bad Request 400

{
  "success": false,
  "error": {
    "code": "invalid_request",
    "message": "The request is invalid."
  }
}

Examples

Basic View Logging

curl -X POST "https://waitlister.me/api/v1/waitlist/your-waitlist-key/log-view" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -d '{}'

View Logging with Visitor ID

curl -X POST "https://waitlister.me/api/v1/waitlist/your-waitlist-key/log-view" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: your-api-key" \
  -d '{
    "visitor_id": "user123-browser456-session789"
  }'

Implementation Notes

Visitor Identification

To accurately track unique views:

  1. Generate a unique visitor_id for each visitor
    • Could be a combination of user ID, browser fingerprint, session ID, etc.
    • Must be unique to the visitor but consistent across their sessions
    • Store in local storage, cookies, or your database
  2. Send this ID with each log-view request
    • Helps prevent duplicate view counts
    • Same visitor is only counted once per 24-hour period

Security Note

In production, you should never expose your API key in client-side code. Instead:

  1. Create a server-side endpoint that calls the Waitlister API
  2. Have your client-side code call your server endpoint
  3. Your server adds the API key before forwarding the request to Waitlister

Using View Data

View data is used in several ways.

  • Analytics Dashboard: See total views, conversion rates, and referring domains
  • Conversion Rate: Calculate the percentage of viewers who join your waitlist
  • Traffic Sources: Identify which channels drive the most traffic and sign-ups

Rate Limits

PlanRate Limit
Pro200 requests per minute
Scale400 requests per minute

See API Rate Limits for more information.

Get started for free

Start collecting sign ups for your product launch in minutes — no coding required.