MachineMetrics

The MachineMetrics Developer Hub

Welcome to the MachineMetrics developer hub. You'll find comprehensive guides and documentation to help you start working with MachineMetrics as quickly as possible. Let's jump right in!

This provides a basic introduction to the MachineMetrics API.

API Access

The MachineMetrics API is accessed over HTTPS from https://api.machinemetrics.com. All requests and responses are transmitted as JSON using the application/json content-type unless otherwise specified.

Authentication

The standard way to authenticate with the MachineMetrics API is via OAuth tokens. OAuth tokens will authenticate your application on behalf of a user for a given set of scopes.

To authenticate on behalf of a company, you can use OAuth-compatible API keys. To get started, log into MachineMetrics and create a new API Key. API keys are created with the same scopes as standard OAuth tokens. Your key should be treated like a password and kept secure.

API requests are authenticated via an HTTP Authorization header using your API key.

curl -H "Authorization: Bearer API-KEY" https://api.machinemetrics.com

Client Errors

Errors in API requests will be returned with an appropriate HTTP status code and JSON object describing the error.

Sending invalid JSON or the wrong content-type will result in a 400 Bad Request response.

HTTP/1.1 400 Bad Request
Content-Length: 34

{"message":"Problem parsing JSON"}

Sending invalid fields in a query will result in a 400 Bad Request response with additional information.

HTTP/1.1 400 Bad Request
Content-Length: 146

{
    "code": "ValidationError",
    "message": "Validation Error",
    "errors": [
        {
            "field": "data",
            "code": "InvalidDataItem",
            "message": "Metric 'abc' is not valid"
        }
    ]
}

Most error objects include a code, message, and an errors array containing additional information on 0 or more distinct fields.