Create report

post

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

Create a report

Body Params

tenantID

uuid

required

A unique identifier for an organization

chartType

string

enum

required

Report chart type

compareEndDate

string | null

Compare date range end date

compareStartDate

string | null

Compare date range start date

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

Report date range end date

excludedCreditTypes

array of strings

Excluded credit types

excludedCreditTypes

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

limit

number

Report data limit

measures

array of objects

Report measures

measures

name

string

required

length between 1 and 100

Report name

nLookback

number | null

Report lookback period

reverse

boolean

Report data orientation

rollingWindowOffset

number | null

Rolling window offset

rollingWindowOffsetDurationType

string | null

enum

Rolling window offset duration type

Allowed:

scope

string

enum

Report scope

Allowed:

sharedUserIDs

array of uuids

User IDs to share the report with

sharedUserIDs

sortRule

object

Report sort rule

startDate

string | null

Report date range start date

tags

array of strings

Report tags

tags

timeGranularity

string

enum

Report time granularity

type

string

enum

required

Report type

Allowed:

xAxisKey

string

Report x Axis key

Responses

Language

Credentials

Bearer

JWT

URL

Response

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

application/json