API Developer Guide

Metricly’s RESTful API allows you read and write data programmatically. This means that you can perform a wide variety of tasks, including adding a new integration, returning a filtered list of Events, removing elements from your account, and more.

To view and try out all our API’s visit the Metricly’s Swagger implementation.  This web based user interface allows users to view all the APIs, see additional documentation, and test the calls from your browser.

Available APIs


Did you know we have a Metricly CLI?

Metricly strongly encourages you to use the Metricly CLI when interacting with our API. The CLI has built-in commands and help information, offering a guided experience when interacting with endpoints. You can createdeletelist, or get several of the features inside Metricly through the CLI without having to worry about structuring the JSON payload exactly right. You can install the CLI from GitHub.

Authentication

Metricly requires users to authenticate their requests with HTTP basic auth. Basic authentication uses a standard HTTP header that includes encoded versions of your username and password. Basic authentication is required for all endpoints except ingest and ingest events, which require API keys.

 

Basic authentication is typically provided by your REST client. To enable authentication and access to the API, navigate to the Auth(entication) section of your REST client and provide your login information.

Data Formats

Dates and Times – All request parameters associated with date and time (duration, startTime, endTime) must be written in ISO 8601 format, see examples below.

Unit ISO 8601
Time (hours, minutes, and seconds) hh:mm:ss or hhmmss

Note that ISO 8601 uses a 24-hour clock system.

Time (hours and minutes) hh:mm or hhmm
Duration P<date>T<time>

For duration, an upper case letter indicating a unit of date or time follows its corresponding numerical value. So, where n equals the value of each date or time, duration is written as follows: PnYnMnDnTnHnMnS.

A duration of 1 year, 4 months, 6 days, 12 hours, 35 minutes, and 20 seconds, for example, is represented as P1Y4M6DT12H35M20S.

Also, a duration of 1 month is represented as P1M, while a duration of 1 minute is represented as PT1.

Date (Year, Month, and Day) YYYY-MM-DD or YYYYMMDD
Date (Year and Month) YYYY-MM not YYYYMM
Combined date and time <date>T<time>

For example, a combination of the date January 13, 2015 and the time 11:30 PM is written as 2015-01-13T23:30.

capterra

Join other DevOps who love Metricly!

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