Redox Platform API

The Redox Platform API is a RESTful JSON utility that allows you to automate your monitoring and configuration workflows. Currently, the Platform API allows you to programmatically export log data or create traffic alert rules. Eventually, we plan to allow you to perform other actions within the Redox dashboard via Platform API as an alternative. 

The Platform API is meant to be used by back-end servers accessing Platform API resources and FHIR® endpoints. It also allows you to use record locator service.

Check out our Platform API reference for log endpoint specifications.

We’re currently using the v1 beta version of the Platform API, which was released in July 2021. We expect to release more versions later as we add new endpoints and roll out more changes to the dashboard. 

Our previous v0 alpha version was an experimental set of APIs based on dashboard concepts in early 2021. It may be discontinued at any time with 30-day notice.

Any request made via the Platform API contains the version of the API you're using, as well as your Redox dashboard organization credentials like this:

https://api.redoxengine.com/platform/:version/organization/:id/

You can locate your organization ID in the Organization Profile page of the Redox dashboard.

Required parameters (e.g., requesting a specific log by ID) should go in the URL path like this: /messages/:id.

Optional parameters (e.g., for filtering, sorting, or controlling response output) should be included in the query string like this: ?param=123.

Any datetime query parameters are in ISO 8601 format (e.g., 2023-01-10T19:46:40.081Z)

If you want to paginate or count results in the response, you can add these query parameters:

Every response from the Platform API is contained in a wrapper object, even when the returned value is already an object. This payload wrapper comprises a meta object, which contains metadata about your request, and a payload object, which contains the results related to your request.

The payload object may contain fields that return a single result (singular field name) or an array of results (plural field name).

1
{
2
  "meta": {
3
    "version": "1.1.0",
4
  },
5
  "payload": {
6
    "record": {
7
            // ...single record
8
    },
9
     //OR
10
    "records": [{
11
            // ...first record
12
        },{
13
        //...second record
14
      }]
15
  }
16
}

You can page through results via the links provided in the meta.page object in the response. Specifically, you can page through a set of results using the next and prev paths indicated within the meta.page.links object. At the beginning or end of a set of results, the prev or next links are undefined.

You may also see metadata counts, which display the total size of the result set, including totalRecords, totalPages, and pageSize.

1
{
2
  "meta": {
3
    "version": "3.1.3",  // Required, the version of this payload
4
    "page": {
5
      "links": {
6
        "first": "<path-to-first-page>",
7
        "prev": "<path-to-first-page>",  // undefined on first page
8
        "self": "<path-to-this-returned-page>",
9
        "next": "<path-to-page-after-returned-page>"  // undefined on last page
10
      },
11
      "currentPage": 1,       // Required
12
      "pageType": "offset",   // Required
13
      "pageSize": 20,         // Optional, size of each page
14
      "totalRecords": 124,    // Optional
15
      "totalPages": 7         // Optional
16
    },
17
    // ... other metadata about the request/operation/response ...
18
  },
19
  "payload": {
20
    "records": [{
21
      // ... first record here ... 
22
    }]
23
  }
24
}

If there are any errors, they're returned in a standard payload. For reference, check out a list of possible error codes (under the Failed response section).

1
{
2
  "meta": {
3
    "version": "1.2.3",  // Required, the version of this payload
4
    // ... other metadata about the request/operation/response
5
  },          
6
  "payload": {
7
    "error": {
8
      "id": "failure-instance-identifier",  // Optional, unique ID for this error
9
      "code": "failure.type.code",  // Required
10
      "title": "Failure Type Title String",  // Required
11
      "detail": "Specific failure message",  // Required
12
      "transient": true,  // Required, true implies error might resolve and the request should be retried
13
      "status": 401,  // Optional, response status code
14
      "meta": {}  // Optional, error metadata
15
    },
16
    "errors": [{}]  // Returned if multiple errors
17
  }
18
}