GET
/
metrics
/
options
/
Get metrics options
curl --request GET \
  --url https://api.standardmetrics.io/v1/metrics/options/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "category_name": "<string>",
      "category_id": "<string>",
      "is_standard": true,
      "is_archived": true,
      "type": "<string>",
      "is_point_in_time": true,
      "description": "<string>",
      "choices": [
        "<string>"
      ],
      "is_multiple": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Query Parameters

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

category_name
string

Name of the category

category_id
string

ID of the category

is_standard
boolean

Is category standard

type
enum<string>

Type of the category

Available options:
Integer,
Decimal,
String,
Money,
Percentage,
Select
is_point_in_time
boolean

Is category point in time

is_archived
boolean

Is category archived

choices
string[]

Choice options for the category

is_multiple
boolean

Is the category multiple choice

Response

200 - application/json

The response is of type object.