CaseMethods
Methods¶
getElementStats()¶
getElementStats(
startTime:Date,endTime:Date,packageVersion:string):Promise<ElementStats[]>
Get element stats for this case
Parameters¶
| Parameter | Type | Description |
|---|---|---|
startTime |
Date |
Start of the time range to query |
endTime |
Date |
End of the time range to query |
packageVersion |
string |
Package version to filter by |
Returns¶
Promise<ElementStats[]>
Promise resolving to an array of ElementStats
getIncidentsTimeline()¶
getIncidentsTimeline(
startTime:Date,endTime:Date,options?:Omit<TimelineOptions,"processKeys">):Promise<IncidentTimelineResponse[]>
Get incident counts aggregated by time bucket for this case process.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
startTime |
Date |
Start of the time range to query |
endTime |
Date |
End of the time range to query |
options? |
Omit<TimelineOptions, "processKeys"> |
Optional settings for filtering and time bucket granularity (processKey is auto-captured from this case) |
Returns¶
Promise<IncidentTimelineResponse[]>
Promise resolving to an array of IncidentTimelineResponse
getInstanceStats()¶
getInstanceStats(
startTime:Date,endTime:Date,packageVersion:string):Promise<InstanceStats>
Get instance stats for this case
Parameters¶
| Parameter | Type | Description |
|---|---|---|
startTime |
Date |
Start of the time range to query |
endTime |
Date |
End of the time range to query |
packageVersion |
string |
Package version to filter by |
Returns¶
Promise<InstanceStats>
Promise resolving to InstanceStats
getInstanceStatusTimeline()¶
getInstanceStatusTimeline(
startTime:Date,endTime:Date,options?:Omit<TimelineOptions,"processKeys">):Promise<InstanceStatusTimelineResponse[]>
Get instance status counts aggregated by date for this case process.
Parameters¶
| Parameter | Type | Description |
|---|---|---|
startTime |
Date |
Start of the time range to query |
endTime |
Date |
End of the time range to query |
options? |
Omit<TimelineOptions, "processKeys"> |
Optional settings for filtering and time bucket granularity (processKey is auto-captured from this case) |
Returns¶
Promise<InstanceStatusTimelineResponse[]>
Promise resolving to an array of InstanceStatusTimelineResponse