Update report

patch

https://core-api.ternary.app/api/reports/{reportID}

Update an existing report's configuration, including chart type, dimensions, measures, filters, and date range settings.

Path Params

reportID

uuid

required

Unique report ID

Body Params

chartType

string

enum

Report chart type

compareEndDate

string | null

Compare date range end date

compareStartDate

string | null

Compare date range start date

compareDurationType

string | null

enum

Compare report type

Allowed:

dataLayers

array | null

Report data layers

dataLayers

dataSource

string

enum

Report data source

description

string

Report description

dimensions

array of objects

Report dimensions

dimensions

durationType

string

enum

Report duration duration type

endDate

string | null

Report date range end date

excludeNegativeNumbers

boolean

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

isCompareStartDate

boolean | null

Compare start date boolean

isCumulative

boolean

Cumulative report data

limit

number | null

Report data limit

measures

array of objects

Report measures

measures

name

string

length between 1 and 100

Report name

nLookback

number | null

Report lookback period

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:

showTotalsTable

boolean

Show totals instead of time series data in table

sortRule

object | null

Report data sort rule

startDate

string | null

Report date range start date

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden