GBgbif
Species

Name usage metrics by id

Changed on

Retrieves metrics for a single name usage.

get/v1/species/{usageKey}/metrics

Request

Path parameters

usageKeyinteger required

Name usage key.

Response

Name usage metrics found

keyinteger

The name usage key that uniquely identifies this name usage.

numPhyluminteger

Returns the number of phyla that are below this taxon. Typically, this would mean this usage is of something above the “phylum” taxonomic level.

numClassinteger

Returns the number of classes that are below this taxon. Typically, this would mean this usage is of something above the “class” taxonomic level.

numOrderinteger

Returns the number of orders that are below this taxon. Typically, this would mean this usage is of something above the “order” taxonomic level.

numFamilyinteger

Returns the number of families that are below this taxon. Typically, this would mean this usage is of something above the “family” taxonomic level.

numGenusinteger

Returns the number of genus that are below this taxon. Typically, this would mean this usage is of something above the “genus” taxonomic level.

numSubgenusinteger

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.

numSpeciesinteger

Returns the number of species that are below this taxon. Typically, this would mean this usage is of something above the “species” taxonomic level.

numChildreninteger

Returns the number of direct taxonomic elements under this usage. “Direct” means that children should have this usageKey as their parentKey.

numDescendantsinteger

The number of all accepted taxonomic elements under this usage.

numSynonymsinteger

Returns the number of related synonyms this usage possses.

Changes

  • 03ccf35f8dd9Revision changes
    • breaking

      the response property became optional for the status (media type: application/json)

    • breaking

      the response property became optional for the status (media type: application/x-javascript)

    • warning

      for the path request parameter usageKey, the min was set to 0.00