Update report

patch

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

Path Params

reportID

uuid

required

Body Params

chartType

string

enum

compareEndDate

string | null

compareStartDate

string | null

compareDurationType

string | null

enum

Allowed:

dataLayers

array | null

dataLayers

dataSource

string

enum

description

string

dimensions

array of objects

dimensions

durationType

string

enum

endDate

string | null

excludeNegativeNumbers

boolean

excludeOther

boolean

favoritedUserIDs

array of strings

favoritedUserIDs

filterGroups

array of objects | null

filterGroups

filters

array of objects

filters

hiddenMeasures

array of strings

hiddenMeasures

invoiceMonthEnd

string | null

invoiceMonthStart

string | null

isCompareStartDate

boolean | null

isCumulative

boolean

limit

number | null

measures

array of objects

measures

name

string

length between 1 and 100

nLookback

number | null

reverse

boolean

rollup

boolean

rollingWindowOffset

number | null

rollingWindowOffsetDurationType

string | null

enum

Allowed:

showTotalsTable

boolean

sortRule

object | null

startDate

string | null

tags

timeGranularity

string | null

enum

scope

string

enum

Allowed:

sharedUserIDs

array of uuids

sharedUserIDs

xAxisKey

string | null

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Operation

400Bad Request

401Unauthorized

403Forbidden