HelsinkiHint - API Stats

The recent addition of scripted REST APIs and API version support has really made working with ServiceNow integrations as easy and robust as they should be in this day of highly connected systems. Managing, supporting, and deprecating API versions can be a challenge if you don't have access to usage statistics. The Helsinki release takes API management to a new level.

You can now access detailed usage trends for all client requests to an instance's REST and SOAP endpoints. Trending by API type, endpoint, method, and version are all available via the new Web API Usage Overview dashboard.

Let's take a look at the usage dashboard for the "cavu/test" REST API. As with all ServiceNow homepages and dashboards, these are fully customizable.

Probably one of the most useful reports for an API owner is a summary of requests by API version. Depending on the application lifecycle and support model of your API, it can be extremely valuable to understand whether clients are requesting specific versions or using the default published version.

Another useful trend that helps define your maintenance and support needs is the trend of total requests for a given API.

The last piece of commonly used data will help you understand the usage by API method.

I can't spill the beans, but you should be on the lookout for even more REST related analytics and tools coming in Istanbul.