Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ternary Reporting API

Cost reports, dashboards, and analytics

Ternary Reporting API is one of 6 APIs that Ternary publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reporting. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.ternary.app.

3 operations 2 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Server
https://api.ternary.app
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Ternary Reporting API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-API-Key (ApiKeyAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key generated from the Ternary platform settings

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Reporting 3

Cost reports, dashboards, and analytics

GET
/v1/reports
List Reports
listReports 2 params → 200401
POST
/v1/reports
Create Report
createReport body → 201401
POST
/v1/reports/{report_id}/data
Run Report
runReport 1 param body → 200401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Report (7 properties), ReportData (6 properties), ReportRequest (5 properties), ReportListResponse (3 properties). Each schema is shown below with its type and property counts.

Report
object
A saved cost report configuration
7 properties
ReportListResponse
object
3 properties
ReportRequest
object
5 properties 1 required
ReportData
object
Executed report data with cost breakdown results
6 properties
ErrorResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ternary-reporting-api-openapi.yml Raw ↑

Other APIs Ternary publishes across the network.

Ternary Anomaly Detection API
Ternary Commitments API
Ternary Cost Allocation API
Ternary Forecasting API
Ternary Kubernetes API