/v1/analytics/track/:id

Update an existing page view tracking entry with engagement metrics. Use this to send periodic updates or final metrics when the user leaves.

Endpoint

Path Parameters

Request Body

Response

Example Request

curl -X PUT "https://api.simplist.blog/v1/analytics/track/pv_xyz789" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d "{\"timeOnPage\":125,\"scrollDepth\":85,\"exitPosition\":85,\"bounced\":false}"

Request Body

{
  "timeOnPage": 125,
  "scrollDepth": 85,
  "exitPosition": 85,
  "bounced": false,
  "events": [
    {
      "type": "button_click",
      "element": "share-button",
      "timeOffset": 45000
    }
  ]
}

Example Response

{
  "data": {
    "success": true
  }
}

Usage Pattern

1. Initialize tracking with POST/v1/analytics/track
2. Store the returned ID
3. Update periodically (every 30s) with current metrics
4. Send final update when user leaves page

const response = await fetch('https://api.simplist.blog/v1/analytics/track', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ slug: 'my-article', timeOnPage: 0 })
})

const { id } = await response.json()

SDK Equivalent

If you're using TypeScript/JavaScript, you can use the SDK instead: client.analytics.update()