The users API allows you to access and manage your users. To explore Metricly’s REST API and test some requests, go here.

Metricly CLI

The Metricly CLI provides a command-line interface to the Metricly API. See the GitHub page for installation steps.

Swagger

To explore Metricly’s REST API and test some requests, go here. Log in using your Metricly credentials.

Get a List of Users

This method will return a list of users associated with a tenant.

Method GET URL https://api.app.metricly.com/users
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Create a User

This method creates a user for a tenant.

Method POST URL https://api.app.metricly.com/users
Parameters Required/Optional Description
wrapper Optional Body parameter; see below

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body

Attribute Required/Optional Description
active Optional Whether the user is active or not.
administrator Optional Whether the user is an administrator for the tenant or not.

Only one of either administrator or readOnly may be passed in as true, but if neither the administrator or readOnly attributes are specified, the user will default to being an administrator.
email Optional The email of the user used for logging in.
id Optional The ID of the user.
password Optional The password of the user.
properties Optional A list of the user’s stored preferences, sorts, selected theme and nav, daily report settings, and modal settings.
readOnly Optional Whether the user is a read only user.

Get Current User

This method will return information about the user currently signed in.

Method GET URL https://api.app.metricly.com/users/current
Parameters Required/Optional Description
N/A N/A N/A

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Delete a User

This method will delete a given user.

Method DELETE URL https://api.app.metricly.com/users/{id}
Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Get a User by ID

This method will return a user for the given id.

Method GET URL https://api.app.metricly.com/users/{id}
Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Update a User

This method will allow you to update a given user’s information.

Method PUT URL https://api.app.metricly.com/users/{id}
Replace {id} in the above URL with the user ID from any of your users.
Parameters Required/Optional Description
id Required URL (path) parameter. The ID of the user.
wrapper Optional Body parameter; see below

Input JSON Format for Request Header 
Header Name Header Value
Content-Type application/json
Authorization: Basic (Base64 encoded authentication value)

Input JSON Format for Request Body
Attribute Required/Optional Description
active Optional Whether the user is active or not.
administrator Optional Whether the user is an administrator for the tenant or not.

Only one of either administrator or readOnly may be passed in as true, but if neither the administrator or readOnly attributes are specified, the user will default to being an administrator.
email Optional The email of the user used for logging in.
id Optional The ID of the user.
id Optional The ID of the user.
password Optional The password of the user.
properties Optional A list of the user’s stored preferences, sorts, selected theme and nav, daily report settings, and modal settings.
readOnly Optional Whether the user is a read only user.

capterra

Join other DevOps who love Metricly!

Sign up for a free, fully featured, 21-day trial. No credit card required!