Create report

post

https://core-api.ternary.app/api/reports

Create a new cost and usage report. Reports visualize cloud billing data with configurable dimensions, measures, filters, and chart types.

Chart types: AREA, CLUSTERED_BAR, HORIZONTAL_BAR, KPI, KPI_TOP_ITEM, LINE, PIE, STACKED_AREA, STACKED_BAR, TABLE, VARIANCE, WATERFALL

Duration types: CUSTOM, INVOICE, LAST_MONTH, LAST_N_DAYS, LAST_N_MONTHS, LAST_NINETY_DAYS, LAST_SEVEN_DAYS, LAST_THIRTY_DAYS, MONTH_TO_DATE, QUARTER_TO_DATE, TODAY, YEAR_TO_DATE, YESTERDAY

Scope values: PUBLIC (visible within the organization), GLOBAL (visible to all), PRIVATE (visible to creator only), SHARED (visible to specific users)

See Reports for configuration guidance.

When scope is omitted, the API creates a PUBLIC report visible within the organization. PUBLIC differs from PRIVATE, SHARED, and GLOBAL; a UI-selected default does not change the API default.

PUBLIC still requires report-read permission and does not mean anonymous internet access. Set PRIVATE explicitly for a private API-created report; the standalone UI uses a Private default.

Body Params

tenantID

uuid

required

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

A unique identifier for an organization

chartType

string

enum

required

Report chart type

compareEndDate

string | null

CUSTOM comparison end: the last day compared, as YYYY-MM-DD or that day's UTC midnight. A month (MM/yyyy) for an INVOICE comparison.

compareStartDate

string | null

CUSTOM comparison start: the first day, as YYYY-MM-DD or that day's UTC midnight. A month (MM/yyyy) for an INVOICE comparison.

compareDurationType

string

enum

Compare report duration type

Allowed:

dataLayers

array

Report data layers

dataLayers

dataSource

string

enum

required

Report data source

description

string

Report description

dimensions

array of objects

Report dimensions

dimensions

durationType

string

enum

required

Report duration type

endDate

string | null

Custom date range end: the last day included, as YYYY-MM-DD or that day's UTC midnight. Stored as its UTC midnight. Other timestamps are read as an older client's saved value, which can name a different day.

excludeNegativeNumbers

boolean

required

Exclude negative numbers

excludeOther

boolean

Limit data to exclude other category

favoritedUserIDs

array of strings

Favorited user ids

favoritedUserIDs

filterGroups

array of objects | null

Report filter groups with AND/OR logic

filterGroups

filters

array of objects

Report filters

filters

hiddenMeasures

array of strings

Hidden measure existance

hiddenMeasures

invoiceMonthEnd

string | null

Report invoice month range end date

invoiceMonthStart

string | null

Report invoice month range start date

isCumulative

boolean

Cumulative report data

isLimitEnabled

boolean | null

Whether the displayed-results limit is applied

limit

number

Report data limit

limitMeasure

string | null

Measure schema name the displayed-results limit ranks or compares by

limitOperator

string | null

enum

Displayed-results limit threshold operator; null means Top N

Allowed:

limitValue

number | null

Displayed-results limit threshold value

measures

array of objects

Report measures

measures

name

string

required

length between 1 and 100

Report name

nLookback

number | null

Report lookback period

origin

string

enum

Surface that created the report; omitted when created in the web app

Allowed:

reverse

boolean

Report data orientation

rollup

boolean

Whether to use SQL ROLLUP for hierarchical aggregation with subtotals

rollingWindowOffset

number | null

Rolling window offset

rollingWindowOffsetDurationType

string | null

enum

Rolling window offset duration type

Allowed:

scope

string

enum

Report scope

Allowed:

showTotalsOnBars

boolean

Show totals on stacked and horizontal bar segments

showTotalsTable

boolean

Show totals instead of time series data in table

sharedUserIDs

array of uuids

User IDs to share the report with

sharedUserIDs

sortRule

object

Report sort rule

startDate

string | null

Custom date range start: the first day, as YYYY-MM-DD or that day's UTC midnight. Stored as its UTC midnight. Other timestamps are read as an older client's saved value, which can name a different day.

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden