GET

api

public

teams

{teamId}

metrics

Get Team Metrics

curl --request GET \
  --url https://spaces.nexudus.com/api/public/teams/{teamId}/metrics \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/teams/{teamId}/metrics"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/teams/{teamId}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Metrics": [
    {}
  ],
  "Metrics[].Id": 123,
  "Metrics[].MonthDate": "<string>",
  "Metrics[].CurrencyCode": "<string>",
  "Metrics[].InvoicedAmount": 123,
  "Metrics[].TeamInvoicedAmount": 123,
  "Metrics[].Revenue": 123,
  "Metrics[].CheckingMinutes": 123,
  "Metrics[].TeamCheckingMinutes": 123,
  "Metrics[].BookingMinutes": 123,
  "Metrics[].TeamBookingMinutes": 123,
  "Metrics[].TotalBookings": 123,
  "Metrics[].TotalTariffs": 123,
  "Metrics[].TotalOther": 123,
  "Metrics[].TimePasses": 123,
  "Metrics[].Bookings": 123,
  "Metrics[].TotalUnpaid": 123,
  "Metrics[].TotalUnpaidNexKiosk": 123,
  "Metrics[].TotalDue": 123,
  "Metrics[].UnPaidAttendees": 123,
  "Metrics[].NotInvoicedCharges": 123,
  "Metrics[].UnInvoicedCharges": 123,
  "Metrics[].UnInvoicedProducts": 123,
  "Metrics[].UnInvoicedTimePasses": 123,
  "Metrics[].UnInvoicedExtraServices": 123,
  "Metrics[].NextInvoice": {},
  "Metrics[].DasySinceLastAccess": 123,
  "401 Unauthorized": {},
  "404 Not Found": {}
}

Get Team Metrics

Returns an array of monthly metric snapshots for a team. Each entry covers one calendar month and includes invoiced amounts, booking and check-in minutes, revenue, and outstanding charges. Used on the team dashboard to render trend charts.

Authentication

Requires a valid customer bearer token. The customer must be a team administrator of the specified team.

Path Parameters

number

required

Numeric identifier of the team. Returned as Id from GET /api/public/teams/my.

Query Parameters

string

Comma-separated list of field paths to include in the response. When provided, only the specified fields are returned — useful for reducing payload size. Supports nested paths using dot notation.

Response

TeamMetric[]

required

Array of monthly metric snapshots, ordered chronologically.

Per-Month Fields

number

Unique identifier for the metric record.

string

ISO 8601 date representing the first day of the month this record covers.

string

ISO 4217 currency code for all monetary values in this record.

number

Total invoiced amount for the member in this month.

number

Total invoiced amount across the entire team in this month.

number

Total revenue for the team in this month.

number

Member’s checked-in time in minutes.

number

Total team checked-in time in minutes.

number

Member’s booked time in minutes.

number

Total team booked time in minutes.

number

Total number of bookings.

number

Total number of active membership plans.

number

Total other charges.

number

Number of time passes used.

number

Revenue from bookings.

number

Total unpaid amount.

number

Total unpaid NexKiosk charges.

number

Total amount currently due.

number

Unpaid event attendee charges.

number

Total charges not yet invoiced.

number

Uninvoiced miscellaneous charges.

number

Uninvoiced product charges.

number

Uninvoiced time pass charges.

number

Uninvoiced extra service charges.

string | null

ISO 8601 datetime of the next scheduled invoice, or null if none is scheduled.

number

Days since the member’s last portal access. Note the typo (Dasy) — it is preserved as-is in the API.

Examples

Fetch team metrics

GET /api/public/teams/55/metrics
Authorization: Bearer {token}

{
  "Metrics": [
    {
      "Id": 1001,
      "MonthDate": "2025-01-01T00:00:00",
      "CurrencyCode": "GBP",
      "InvoicedAmount": 1250.0,
      "TeamInvoicedAmount": 8500.0,
      "Revenue": 8500.0,
      "CheckingMinutes": 2400,
      "TeamCheckingMinutes": 18000,
      "BookingMinutes": 480,
      "TeamBookingMinutes": 3200,
      "TotalBookings": 15,
      "TotalTariffs": 12,
      "TotalOther": 0,
      "TimePasses": 3,
      "Bookings": 450.0,
      "TotalUnpaid": 200.0,
      "TotalUnpaidNexKiosk": 0,
      "TotalDue": 200.0,
      "UnPaidAttendees": 0,
      "NotInvoicedCharges": 50.0,
      "UnInvoicedCharges": 25.0,
      "UnInvoicedProducts": 15.0,
      "UnInvoicedTimePasses": 10.0,
      "UnInvoicedExtraServices": 0,
      "NextInvoice": "2025-02-01T00:00:00",
      "DasySinceLastAccess": 2
    }
  ]
}

TypeScript Integration

import { endpoints } from '@/api/endpoints'
import { TeamMetrics } from '@/types/endpoints/TeamMetrics'
import { useData } from '@/hooks/useData'

const { resource: metricsData } = useData<TeamMetrics>(httpClient, endpoints.teams.metrics(teamId))

Usage in Portal

Context	Source file
Team dashboard metrics section (`/dashboard/team/{teamId}`)	`src/views/user/dashboards/team/components/TeamMetricsSection.tsx`

Error Responses

error

The customer is not authenticated or the session has expired.

error

Team with the specified ID does not exist.

Method	Endpoint	Description
`GET`	`/api/public/teams/{teamId}/kpi`	Per-member KPI data
`GET`	`/api/public/teams/{teamId}/attendance`	Team attendance data
`GET`	`/api/public/teams/{teamId}/profile`	Full team profile
`GET`	`/api/public/teams/my`	List the customer’s teams

Get Team AttendanceReturns attendance data for a team on a given week, including per-member schedules and bookings.

Get Team Metrics

curl --request GET \
  --url https://spaces.nexudus.com/api/public/teams/{teamId}/metrics \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/public/teams/{teamId}/metrics"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/public/teams/{teamId}/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Metrics": [
    {}
  ],
  "Metrics[].Id": 123,
  "Metrics[].MonthDate": "<string>",
  "Metrics[].CurrencyCode": "<string>",
  "Metrics[].InvoicedAmount": 123,
  "Metrics[].TeamInvoicedAmount": 123,
  "Metrics[].Revenue": 123,
  "Metrics[].CheckingMinutes": 123,
  "Metrics[].TeamCheckingMinutes": 123,
  "Metrics[].BookingMinutes": 123,
  "Metrics[].TeamBookingMinutes": 123,
  "Metrics[].TotalBookings": 123,
  "Metrics[].TotalTariffs": 123,
  "Metrics[].TotalOther": 123,
  "Metrics[].TimePasses": 123,
  "Metrics[].Bookings": 123,
  "Metrics[].TotalUnpaid": 123,
  "Metrics[].TotalUnpaidNexKiosk": 123,
  "Metrics[].TotalDue": 123,
  "Metrics[].UnPaidAttendees": 123,
  "Metrics[].NotInvoicedCharges": 123,
  "Metrics[].UnInvoicedCharges": 123,
  "Metrics[].UnInvoicedProducts": 123,
  "Metrics[].UnInvoicedTimePasses": 123,
  "Metrics[].UnInvoicedExtraServices": 123,
  "Metrics[].NextInvoice": {},
  "Metrics[].DasySinceLastAccess": 123,
  "401 Unauthorized": {},
  "404 Not Found": {}
}

​Get Team Metrics

​Authentication

​Path Parameters

​Query Parameters

​Response

​Per-Month Fields

​Examples

​Fetch team metrics

​TypeScript Integration

​Usage in Portal

​Error Responses

​Related Endpoints

Get Team Metrics

Authentication

Path Parameters

Query Parameters

Response

Per-Month Fields

Examples

Fetch team metrics

TypeScript Integration

Usage in Portal

Error Responses

Related Endpoints