API Reference
GET /organisation/:id/availableMetrics

Get available metrics

Discover which metrics are enabled on your organisation, grouped by domain.

Returns the metrics configuration enabled for your organisation. Use it to discover which Metrics API routes are valid for your account before issuing requests.

The response is an object (not an array) whose top-level keys group metric configuration by domain — for example movement, zones, service areas, and sales.

Path parameters

ParameterTypeRequiredDescription
idstringyes24-character hexadecimal organisation ID

Example request

GET https://api.auravisionlabs.com/v1/organisation/64a1b2c3d4e5f6a7b8c9d0e2/availableMetrics
Authorization: Bearer <your_token>

Example response

{
  "organisation": "64a1b2c3d4e5f6a7b8c9d0e2",
  "config": {
    "movement": {
      "title": "Movement Metrics",
      "description": "Visitor movement tracking",
      "metrics": [
        { "key": "within-location-movement", "label": "Movement", "description": "Total movement" }
      ]
    },
    "zones": {
      "title": "Zone Metrics",
      "metrics": [
        { "key": "internal-line-entries", "label": "Zone entries" }
      ]
    },
    "serviceAreas": {
      "title": "Service Area Metrics",
      "metrics": [
        { "key": "area-utilisation", "label": "Utilisation" }
      ]
    },
    "sales": {
      "title": "Sales Metrics",
      "metrics": [
        { "key": "transactions", "label": "Transactions" },
        { "key": "conversion-rate", "label": "Conversion rate" }
      ]
    }
  }
}

Notes

You can also embed the same data on the user profile response in one call by passing ?include=availableMetrics on GET /users/profile.