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

Request

Headers

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

Path Parameters

Parameter	Description
`waitlist-key`	Your unique waitlist key, found in your waitlist settings

Request Body

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

Optional Fields

Field	Type	Description
`visitor_id`	String	A unique identifier for the visitor to prevent duplicate view counts
`metadata`	Object	Additional information about the view
`metadata.referring_domain`	String	Domain that referred the view (overrides HTTP referrer)

Response

Success Response `200`

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

Success Response Fields

Field	Type	Description
`success`	Boolean	Always `true` for successful responses
`message`	String	A 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:

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
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:

Create a server-side endpoint that calls the Waitlister API
Have your client-side code call your server endpoint
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

See API Rate Limits for more information.

Documentation