---
title: "Name usage metrics by id"
method: GET
path: "/v1/species/{usageKey}/metrics"
tags: ["Species"]
---

# Name usage metrics by id

`GET /v1/species/{usageKey}/metrics`

Retrieves metrics for a single name usage.

## Path parameters

- `usageKey` integer, required

## Response `200`

Name usage metrics found

- NameUsageMetrics
  - `key` integer, required — The name usage key that uniquely identifies this name usage.
  - `numPhylum` integer — Returns the number of phyla that are below this taxon. Typically, this would mean this usage is of something above the “phylum” taxonomic level.
  - `numClass` integer — Returns the number of classes that are below this taxon. Typically, this would mean this usage is of something above the “class” taxonomic level.
  - `numOrder` integer — Returns the number of orders that are below this taxon. Typically, this would mean this usage is of something above the “order” taxonomic level.
  - `numFamily` integer — Returns the number of families that are below this taxon. Typically, this would mean this usage is of something above the “family” taxonomic level.
  - `numGenus` integer — Returns the number of genus that are below this taxon. Typically, this would mean this usage is of something above the “genus” taxonomic level.
  - `numSubgenus` integer — Returns the number of distinct subgenera that are below this taxon. Typically, this would mean this usage is of something above the “subgenus” taxonomic level.
  - `numSpecies` integer — Returns the number of species that are below this taxon. Typically, this would mean this usage is of something above the “species” taxonomic level.
  - `numChildren` integer — Returns the number of direct taxonomic elements under this usage. “Direct” means that children should have this usageKey as their parentKey.
  - `numDescendants` integer — The number of all accepted taxonomic elements under this usage.
  - `numSynonyms` integer — Returns the number of related synonyms this usage possses.

## Other responses

- `400` — Invalid query
- `404` — Name usage not found

---

[API](https://skmtc.net/gbif/apis/species-api.md) · [All operations](https://skmtc.net/gbif/apis/species-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gbif/species-api/versions/156fd5bac927/schema)