> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.goautolane.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goautolane.com/_mcp/server.

# Get analytics metrics

GET https://api.goautolane.com/avrh/v1/analytics/metrics

Returns key performance metrics (sessions, occupancy, dwell time) with change percentages compared to the previous period.

Reference: https://docs.goautolane.com/av-ride-hail-analytics/api-reference/analytics/get-metrics

## Authentication

- `Authorization` header (bearer token, required) — Organization API key from your settings page

## Request

### Query parameters

- `siteId` (string, required) — UUID of the site to query analytics for
- `period` (enum, optional, default: today) — Predefined time period (ignored when startDate/endDate provided)
  - Allowed values: `today`, `week`, `month`
- `startDate` (datetime, optional) — Custom range start (ISO 8601). Must be paired with endDate.
- `endDate` (datetime, optional) — Custom range end (ISO 8601). Must be paired with startDate.

## Response

### 200

Successful response

- `status` (enum, required)
  - Allowed values: `success`
- `data` (MetricsDataSchema, required) — Key metrics summary returned by the analytics metrics endpoint

## Errors

### 400 Bad Request Error

Invalid query parameters

- `status` (enum, required)
  - Allowed values: `error`
- `message` (string, required)
- `errors` (map from string to any, optional)

### 401 Unauthorized Error

Missing or invalid authentication

- `status` (enum, required)
  - Allowed values: `error`
- `message` (string, required)
- `errors` (map from string to any, optional)

### 403 Forbidden Error

Access denied — site does not belong to your organization

- `status` (enum, required)
  - Allowed values: `error`
- `message` (string, required)
- `errors` (map from string to any, optional)

### 429 Too Many Requests Error

Rate limit exceeded

- `status` (enum, required)
  - Allowed values: `error`
- `message` (string, required)
- `errors` (map from string to any, optional)

## Types

### MetricsDataSchema

Key metrics summary returned by the analytics metrics endpoint

- `autolane_sessions` (MetricsDataSchemaAutolaneSessions, required)
- `average_occupancy` (MetricsDataSchemaAverageOccupancy, required)
- `average_dwell_time` (MetricsDataSchemaAverageDwellTime, required)

### MetricsDataSchemaAutolaneSessions

- `total` (double, required)
- `change_percentage` (double, required)
- `change_type` (enum, required)
  - Allowed values: `increase`, `decrease`, `stable`

### MetricsDataSchemaAverageOccupancy

- `percentage` (double, required)
- `change_percentage` (double, required)
- `change_type` (enum, required)
  - Allowed values: `increase`, `decrease`, `stable`

### MetricsDataSchemaAverageDwellTime

- `minutes` (double, required)
- `seconds` (double, required)
- `total_seconds` (double, required)
- `change_percentage` (double, required)
- `change_type` (enum, required)
  - Allowed values: `increase`, `decrease`, `stable`

## Examples

**Response**

```json
{
  "status": "success",
  "data": {
    "autolane_sessions": {
      "total": 1.1,
      "change_percentage": 1.1,
      "change_type": "increase"
    },
    "average_occupancy": {
      "percentage": 1.1,
      "change_percentage": 1.1,
      "change_type": "increase"
    },
    "average_dwell_time": {
      "minutes": 1.1,
      "seconds": 1.1,
      "total_seconds": 1.1,
      "change_percentage": 1.1,
      "change_type": "increase"
    }
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.goautolane.com/avrh/v1/analytics/metrics"

querystring = {"siteId":"siteId"}

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.goautolane.com/avrh/v1/analytics/metrics?siteId=siteId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```