Skip to navigation

Categories Metadata

Get metadata for benchmark categories.

Returns information about all enabled benchmark categories including:

  • Category names and friendly display names
  • Default user type for each category (business or consumer)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful Response
namestring
The name of the category.
friendly_namestring
The friendly displayable name of the category.
parent_namestring or nullOptional
The name of the parent category.
preferred_user_typeenumOptional
The preferred user type for the category.
descriptionstringOptionalDefaults to
A short description of the category.
long_descriptionstringOptionalDefaults to
A long description of the category.
enabledbooleanOptionalDefaults to true
Whether the category is enabled.