xMatters REST API enhancements for extended data access



With our new expanded data retention capabilities in place, we're giving you more access to your data. But with all the snazzy new reporting features showing up in the web user interface, API users are probably wondering "what about us"? Don't worry, we haven't forgotten about you!

Starting in our Defender release, we're updating our xMatters REST API for endpoints that support enhanced data access.

Accessing Data

Get ready for some "wibbly-wobbly, timey-wimey stuff" because we've enhanced the xMatters REST API with an  at  parameter that lets you tap into the time machine capabilities of our new feature.

The way it works is pretty simple: if you specify the at parameter, the xMatters REST API runs your query against your historical data and returns what is stored for your system at that point in time.

For example, if your query reads GET /people,you'll see a list of users currently in your database.  If your query reads GET /people?at={timestamp}, you'll see all the users who were in your system at the specified date and time, such as 9:00 am on October 8, 2018.

Early Access and Permissions

We wanted to provide access to this new API feature as soon as we could. However, the historical data does not yet enforce user level permissions. So any user with access to the historical data can see all data no matter what their assigned user roles and permissions are.

To ensure you can control who has access in your system, we've put in a temporary permission that can be granted (or revoked) for any user role. Contact xMatters Customer Support for help adding this permission to your user roles.

A note about data access and availability

Like the All Events report, which allows you to look up historical event data via the web user interface, you're able to use the at parameter to view data as far back as your pricing plan allows. For more information about the data retention limits, see our support article Extended data retention

Have more questions? Submit a request


Article is closed for comments.
Powered by Zendesk