With this update the Cloudability Cost Report endpoint is available on the v3 API. This is the first of six endpoints to be launched on Cloudability’s latest-gen public API over the coming weeks. We encourage any customers still using the v1 API to switch to the v3 API at their earliest convenience. 

For a quick starter video guide on using the cost report endpoint checkout this post.

This endpoint can be used to dynamically run cost reports, returning detailed information about your organization’s cloud spend in JSON or CSV, often done programmatically and as a part of automated processes. The endpoint can also be used to enqueue reports for future retrieval. Flexible filtering, sorting, and measure (dimensions and metrics) selection is available to craft results to meet specific reporting needs. Availability on the v3 API brings benefits including being backed by a high-performance cloud app, a fully RESTful interface with predictable resource-orientated URLs and well-factored payloads, and comprehensive user documentation.

Similarities and differences between v1 and v3 for cost reports

To make the transition to v3 as straightforward as possible changes to the query parameters and the payload returned for the cost reports has been kept at a minimum. Therefore, how you execute a specific report and then parse its results remains largely consistent.

The notable differences between v1 and v3 for cost reports are:

• The sort_by parameter is now named sort to match the v3 standard
• There is no longer an order Instead DESC or ASC is appended to the sort value
• The max_results parameter is now named limit to match the v3 standard
• Cost figures are no longer prefixed with the $ symbol, instead represented as numbers. The symbol was removed in consideration that customers can switch reporting to a preferred currency
• v3 offers an automated pagination system, navigated via tokens, for when rows exceed 10,000

Example request

To run a cost report that returns a JSON based response simply run a GET request at curl https://api.cloudability.com/v3/reporting/cost/run with query parameters matching the dates, dimensions, and filters relevant to you.

Figure 1: example cost report made via curl

General considerations when moving from v1 to v3 API endpoints

Individual API documents have been added to the v3 user documentation for each endpoint. Changes at the endpoint interface level between v1 and v3 are reflected within the endpoint documentation.

Some general differences between the v1 and v3 APIs:

• Base URL: https://app.cloudability.com/api/1/ https://api.cloudability.com/v3/
• Authentication: standard method for v1 is via URL query parameter while v3 is via Basic Auth HTTP header.
• Rate Limiting: the v3 API is limited to 300 calls per minute for each user

For helpful information about shifting from v1 to v3 endpoints please check out the Apptio Community and join the discussion!

Stay tuned as the complete set of end points becomes available on the v3 API

Look out for further updates as our engineering team launches the complete set of endpoints on the v3 API. Announcements will also be made regarding the future of the v1 API.