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.
This endpoint accepts either a per-waitlist API key or an account API key (wl_acct_…), and requires the Growth plan or higher.
Want the full picture in one fetch? The one-page integration guide covers every path with copy-paste code · OpenAPI spec · SDK: npm install waitlister
Endpoint Details
- URL:
https://waitlister.me/api/v1/waitlist/{waitlist-key}/log-view - Method:
POST
Request
Headers
code
Content-Type: application/json
X-Api-Key: your-api-key
Path Parameters
| Parameter | Description |
|---|---|
waitlist-key | Your unique waitlist key, shown on your waitlist's Overview page |
Request Body
json
{
"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
json
{
"success": true,
"message": "Successfully logged view"
}
Success Response Fields
| Field | Type | Description |
|---|---|---|
success | Boolean | true if the view was logged, false if this visitor_id was already logged |
message | String | A human-readable message |
Error Responses
Bad Request 400
json
{
"statusCode": 400,
"error": true,
"message": "Metadata must be an object"
}
Examples
Basic View Logging
bash
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
bash
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_idfor 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
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.