API Endpoints

Complete reference for all Pipetrace API endpoints.

Sites

List Sites

GET /api/v1/sites

Returns all sites for the authenticated user.

Get Site

GET /api/v1/sites/:siteId

Create Site

POST /api/v1/sites

{
  "domain": "example.com",
  "name": "My Website"
}

Update Site

PATCH /api/v1/sites/:siteId

{
  "name": "Updated Name"
}

Delete Site

DELETE /api/v1/sites/:siteId

Analytics

Overview

GET /api/v1/sites/:siteId/analytics/overview?period=7d

Returns aggregate statistics for the period.

{
  "data": {
    "visitors": 1234,
    "pageviews": 5678,
    "bounceRate": 45.2,
    "avgDuration": 180,
    "visitorsChange": 12.5,
    "pageviewsChange": 8.3
  }
}

Time Series

GET /api/v1/sites/:siteId/analytics/timeseries?period=7d

Returns data points for charts.

Top Pages

GET /api/v1/sites/:siteId/analytics/pages?period=7d&limit=10

Top Sources

GET /api/v1/sites/:siteId/analytics/sources?period=7d&limit=10

Devices

GET /api/v1/sites/:siteId/analytics/devices?period=7d

Browsers

GET /api/v1/sites/:siteId/analytics/browsers?period=7d

Live Count

GET /api/v1/sites/:siteId/analytics/live

Returns the number of visitors in the last 5 minutes.

Query Parameters

ParameterTypeDescription
periodstringOne of: 24h, 7d, 30d, 90d
limitnumberMax results to return (default: 10, max: 100)

HTTP Status Codes

CodeMeaning
200Success
201Created
204No Content (successful delete)
400Bad Request (validation error)
401Unauthorized (missing/invalid token)
404Not Found
429Too Many Requests (rate limited)
500Internal Server Error