Skip to main content

1E 8.1 (on-premises)

SystemStatistics

Entity - System Statistics - Interrogates the instrumentation statistics of the system

Verb

Request

Notes

Permissions required

GET

/Consumer/SystemStatistics/ HighLevel

Returns high level system statistics.

Example Response

{
        ConnectedDeviceCount,
        ConnectedDeviceCountLastSevenDays,
        InstructionInProgressCount,
        InstructionsPendingApproval,
        DeviceAuthorizationRequests,
        License
        {
                DaysLeft,
                ExpiryDateTime
        }
 }

New for API Version 8.0 : The statistics only refer to the devices and instructions that are visible to the user after imposing the Management Group restrictions. This means that the returned ConnectedDeviceCount and ConnectedDeviceCountLastSevenDays are counting the number of connected devices that are visible to the user, and similarly InstructionInProgressCount, InstructionsPendingApproval and ScheduledInstructionsPendingApproval refer to the instructions that are visible to the user.

None required

GET

/Consumer/SystemStatistics/ Detail

Returns detailed system statistics.

Example Response

{
        ConnectedDeviceCount,
        AllDeviceCount,
        ConnectedDeviceLastSevenDaysCount,
        QuestionInProgressCount,
        AllQuestionCount,
        QuestionResponseAvailableCount,
        ActionInProgressCount,
        AllActionCount,
        ActionResponseAvailableCount,
        AllEventCount,
        EventsInProgressCount,
        EventsResponseAvailableCount
}

Obsolete

The eventing infrastructure was deprecated in v3.0 and fully removed in v4.2. This means that the two fields EventsInProgressCount and EventsResponseAvailableCount will not be available from this version onwards.

New for API version 8.0 : The statistics now only refer to the devices and instructions that are visible to the user after imposing the Management Group restrictions.

None required

POST

/Consumer/SystemStatistics/ ProjectedInstructionStatistics

Returns projected statistics for a given instruction definition.

Example Request

{
        Id,
        Expression
}

Where Id is the Id of the instruction definition and Expression can be used as an option to pass in a scope expression.

Example Response

{
        Id
        TotalRuns
        TotalDevices
        EstimatedCount
        EstimatedBytesReceived
        EstimatedAvgExecTime
        EstimatedBytesSent
        EstimatedRowInserts
        EstimatedRowProcessed
        EstimatedSuccessRespondents
        EstimatedSuccessNoDataRespondents
        EstimatedErrorRespondents
        EstimatedNotImplementedRespondents
        EstimatedResponseTooLargeRespondents
        InstructionId
}

New for API version 8.0 : When computing the projected statistics, the API now only takes into account the existing statistics that were captured from instructions that are accessible to the user in accordance to the Management Groups.

Execute permission on the product pack the instruction definition came from

In this section: