Getting Started

Quickstart

Quickstart

Make your first analytics API call in under 2 minutes.

Prerequisites

  • An Autolane account with at least one active site
  • An API key with analytics:read permission (create one here)

1. Get today’s metrics

$curl -s -H "Authorization: Bearer YOUR_API_KEY" \
>  "https://api.goautolane.com/api/analytics/metrics?siteId=YOUR_SITE_ID&period=today" | jq

Example response:

1{
2  "status": "success",
3  "data": {
4    "autolane_sessions": {
5      "total": 142,
6      "change_percentage": 12.5,
7      "change_type": "increase"
8    },
9    "average_occupancy": {
10      "percentage": 67.3,
11      "change_percentage": -3.1,
12      "change_type": "decrease"
13    },
14    "average_dwell_time": {
15      "minutes": 4,
16      "seconds": 30,
17      "total_seconds": 270,
18      "change_percentage": 5.0,
19      "change_type": "increase"
20    }
21  }
22}
$curl -s -H "Authorization: Bearer YOUR_API_KEY" \
>  "https://api.goautolane.com/api/analytics/occupancy-trends?siteId=YOUR_SITE_ID&period=today&granularity=hour" | jq

3. Explore the API Reference

See the full API Reference for all available endpoints, query parameters, and response schemas.

Common query parameters

All analytics endpoints accept these parameters:

ParameterTypeDefaultDescription
siteIdUUIDrequiredSite to query
periodstringtodaytoday, week, or month
startDateISO 8601—Custom range start (pair with endDate)
endDateISO 8601—Custom range end (pair with startDate)