Sign in
AlertDefinition

Retrieves all the alert definitions for the current company.

get/alertdefinitions

Response

OK

idstring nullable
typestring nullable
createDatestring date-time
createdBystring nullable
ownerstring nullable
lastModifiedDatestring date-time
targetForecastModelIdstring uuid nullable
calculationType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

The transformation applied to the data.

Possible options:

None 1

PeriodOverPeriod 2

YearOverYear 3

ThreePeriodYearOverYear 6

comparerstring nullable
thresholdnumber double
timeframeinteger
companyIdstring nullable
startDatestring date-time nullable
notificationEmailsstring[] nullable
notesstring nullable
containingEntityIdstring uuid nullable
containingEntityTypestring nullable

Changes

No recorded changes to this endpoint across all 2 revisions of this API.