Listing Device Monitoring Details

Use this API Call to query our Data Extraction API to extract data gathered by N-sight RMM.This section shows the service name and parameters needed in the API Call query, and provides examples of some queries and system responses. For more information, see Data Extraction API.

Service name: list_device_monitoring_details

URL

https://SERVER/api/?apikey=yourAPIkey&service=list_device_monitoring_details

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Lists all monitoring information for the device (server or workstation) identified by the deviceid.

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

deviceid

The deviceid must be a valid id.

integer

yes

0

0

Example Service Call =list_device_monitoring_details&deviceid=DEVICEID

https://SERVER/api/?apikey=yourAPIkey&service=list_device_monitoring_details&deviceid=DEVICEID

Example Response: Server 

<?xml version="1.0"?>
<result created="2010-08-30T12:53:05+01:00" host="SERVER" status="OK">
<server>
        <id>78401</id>
        <name>SERVER3</name>
        <description>Dashboard Description</description>
        <username>Company\Administrator</username>
        <guid>1234567890</guid>
        <os>Microsoft Windows </os>
        <agent>Agent v8.2.6</agent>
        <lastresponse>2010-08-13 16:54:35</lastresponse>
        <lastboot>2010-08-02 09:12:56</lastboot>
        <checks count="28">
                <check>
                        <checkid>2089484</checkid>
                        <dsc_247>2</dsc_247>
                        <description>Windows Service Check - TCP/IP NetBIOS Helper</description>
                        <extra>Status RUNNING</extra>
                        <datetime>2010-08-13 17:54:34</datetime>
                        <consecutive_fails>0</consecutive_fails>
                        <emailalerts>1</emailalerts>
                        <smsalerts>0</smsalerts>
                        <servertime>2010-08-30 12:53:05</servertime>
                </check>
                ..... more check nodes
        </checks>
       
        <notes count="3">
                <note>
                        <noteid>117575</noteid>
                        <created>2010-07-01 11:38:14</created>
                        <description>1007 // Performance Monitoring Check - Memory Usage</description>
                        <devicename>SERVER3</devicename>
                        <checkdescriptorid>1007</checkdescriptorid>
                        <checkdescription>Performance Monitoring Check - Memory Usage</checkdescription>
                        <note>Memory is far too low</note>
                        <public_note>Recommend upgrade, consistent issue.</public_note>
                        <login>user@example.com</login>
                </note>
                <note>
                        <noteid>117575</noteid>
                        <created>2010-07-01 11:38:14</created>
                        <description>SERVER3</description>
                        <devicename>SERVER3</devicename>
                        <checkdescriptorid/>
                        <checkdescription/>
                        <note>Tonights tape loaded & formatted OK</note>
                        <public_note>Tonights tape loaded & formatted OK</public_note>
                        <login>user@example.com</login>
                </note>
                ..... more note nodes
        </notes>
<takecontrol>1</takecontrol>
<patch>1</patch>
<mav>1</mav>
<mob>0</mob>
<systray>1</systray>
<mavbreck>0</mavbreck> 
</server>
</result>

Example Response: Workstation 

<?xml version="1.0"?>
<result created="2010-08-30T12:53:05+01:00" host="SERVER" status="OK">
<workstation>
        <id>78401</id>
        <name>WORKSTATION3</name>
         <description>Dashboard Description</description>
        <username>Company\User</username>
        <os>Microsoft Windows</os>
        <agent>Agent v8.2.6</agent>
        <lastresponse>2010-08-13 16:54:35</lastresponse>
        <lastboot>2010-08-02 09:12:56</lastboot>
        <checks count="28">
                <check>
                        <checkid>2089484</checkid>
                        <dsc_247>2</dsc_247>
                        <description>Windows Service Check - TCP/IP NetBIOS Helper</description>
                        <extra>Status RUNNING</extra>
                        <datetime>2010-08-13 17:54:34</datetime>
                        <consecutive_fails>0</consecutive_fails>
                        <emailalerts>1</emailalerts>
                        <smsalerts>0</smsalerts>
                        <servertime>2010-08-30 12:53:05</servertime>
                </check>
                ..... more check nodes
        </checks>
        <notes count="3">
                <note>
                        <noteid>117575</noteid>
                        <created>2010-07-01 11:38:14</created>
                        <description>1007 // Performance Monitoring Check - Memory Usage</description>
                        <devicename>WORKSTATION3</devicename>
                        <checkdescriptorid>1007</checkdescriptorid>
                        <checkdescription>Performance Monitoring Check - Memory Usage</checkdescription>
                        <note>Memory is far too low</note>
                        <public_note>Recommend upgrade, consistent issue.</public_note>
                        <login>user@example.com</login>
                </note>
                <note>
                        <noteid>117575</noteid>
                        <created>2010-07-01 11:38:14</created>
                        <description>WORKSTATION3</description>
                        <devicename>WORKSTATION3</devicename>
                        <checkdescriptorid/>
                        <checkdescription/>
                        <note>Tonights tape loaded & formatted OK</note>
                        <public_note>Tonights tape loaded & formatted OK</public_note>
                        <login>user@example.com</login>
                </note>
                ..... more note nodes
        </notes>
<takecontrol>1</takecontrol>
<patch>1</patch>
<mav>1</mav>
<mob>0</mob>
<systray>1</systray>
<mavbreck>0</mavbreck> 
</workstation>
</result>

Fields Description

Field

Type

Can Be Empty

Description

result/[server/workstation]/id

Integer

No

Unique Identifier of device

result/[server/workstation]/name

String

No

Name of the device

result/[server/workstation]/username

String

Yes

Logged on user

result/[server/workstation]/description

String

Yes

Device's Dashboard description

result/[server/workstation]/guid

String

No

GUID of the device

result/[server/workstation]/os

String

Yes

Operating System of the device

result/[server/workstation]/agent

String

Yes

The formatted version number of the agent on the device

result/[server/workstation]/lastresponse

Datetime

Yes

The last date and time the device responded

result/[server/workstation]/lastboot

Datetime

Yes

The last date and time the device was booted

result/[server/workstation]/checks@count

Integer

No

The number of checks

result/[server/workstation]/checks/check/checkid

Integer

No

Unique Identifier of the check

result/[server/workstation]/checks/check/dsc_247

Integer

Yes

Is the check a Daily Safety Check, 24x7 Check, Scheduled Task or special case?

Indicator

Check

1

24x7 check

2

Daily Safety Check

3

Scheduled Task

4

Managed Antivirus Check

6

Backup & Recovery Selected Size Check

result/[server/workstation]/checks/check/description

String

Yes

Description of the check

result/[server/workstation]/checks/check/checkstatus

String

No

Icon to use for the check status States available:

testok

green tick

testerror

red cross

testalertdelayed

yellow tick

testcleared

orange tick

test_inactive

clear circle

testok_inactive

clear tick

testerror_inactive

clear cross

overdue

clear hourglass

overdue_error

half red filled hour glass

result/[server/workstation]/checks/check/extra

String

Yes

Extra Information about the check

result/[server/workstation]/checks/check/datetime

Datetime

Yes

Date and time when the check occurred

result/[server/workstation]/checks/check/consecutive_fails

Integer

No

Number of consecutive failures

result/[server/workstation]/checks/check/emailalerts

Integer (1 or 0)

No

If the check is configured to send email alerts

0

No

1

Yes

result/[server/workstation]/checks/check/smsalerts

Integer (1 or 0)

No

If the check is configured to send SMS alerts

0

No

1

Yes

result/[server/workstation]/checks/check/emailrecoveryalerts

Integer (1 or 0)

no

If the check is configured to send recovery email alerts

0

No

1

Yes

result/[server/workstation]/checks/check/smsrecoveryalerts

Integer (1 or 0)

No

If the check is configured to send recovery SMS alerts

0

No

1

Yes

result/[server/workstation]/checks/check/servertime

Datetime

No

Current date and time of server

result/[server/workstation]/outages@count

Integer

No

The number of outages

result/[server/workstation]/outages/outage/id

Integer

No

Unique Identifier of outage

result/[server/workstation]/outages/outage/checkid

Integer

Yes

Unique Identifier of associated check

result/[server/workstation]/outages/outage/descriptorid

Integer

Yes

Type of check

result/[server/workstation]/outages/outage/clearcheck

String

Yes

Outage checkbox state

result/[server/workstation]/outages/outage/checkstatusicon

String

Yes

Icon to use for the outage status States available:

spacer

check outage closed or any state of device outage

checkadded

clear plus

testok

green tick

testerror

red tick

testalertdelayed

yellow tick

testcleared

orange tick

test_inactive

clear circle

testok_inactive

clear tick

testerror_inactive

clear cross

overdue

clear hourglass

overdue_error

half red filled hour glass

result/[server/workstation]/outages/outage/frequencyicon

String

Yes

Icon to use for the check frequency

result/[server/workstation]/outages/outage/typeicon

String

Yes

Icon to use for the check type

result/[server/workstation]/outages/outage/description

String

Yes

Description of outage

result/[server/workstation]/outages/outage/duration

String

Yes

Duration of the outage Number of seconds and formatted values are returned separated by _ (underscore character)

result/[server/workstation]/outages/outage/psaticketstatus

String

Yes

Status of associated PSA Ticket

result/[server/workstation]/outages/outage/startdate

String

Yes

Date and time of when the outage started Timestamp and formatted values are returned separated by _ (underscore character)

result/[server/workstation]/outages/outage/enddate

String

Yes

Date and time of when the outage finished Timestamp and formatted values are returned separated by _ (underscore character)

result/[server/workstation]/outages/outage/isclosed

Integer (1 or 0)

No

If the outage is closed or not

0

No

1

Yes

result/[server/workstation]/outages/outage/psaticketstatusid

Integer

No

Status indicator of associated PSA Ticket

11

Opening

12

Open failed

13

Open

14

Closing

15

Closing failed

16

Closed

19

Reopening

20

Reopening failed

21

Opening canceled

22

Reopening canceled

result/[server/workstation]/outages/outage/failreason

String

Yes

Reason for failure

result/[server/workstation]/notes@count

Integer

No

The number of notes

result/[server/workstation]/notes/noteid

Integer

No

Unique Identifier for the note

result/[server/workstation]/notes/created

Datetime

No

The date and time of when the note was created

result/[server/workstation]/notes/description

String

No

Name of Device, or Check ID // Check Description if available

result/[server/workstation]/notes/devicename

String

No

Name of Device

result/[server/workstation]/notes/checkdescriptorid

String

Yes

Check ID if available

result/[server/workstation]/notes/checkdescription

String

Yes

Check Description if available

result/[server/workstation]/notes/note

String

Yes

The private note

result/[server/workstation]/notes/public_notes

String

Yes

The public note

result/[server/workstation]/notes/login

String

No

The email address of the user who created the note

result/[workstation|server] / takecontrol

integer (1 or 0)

no

Is Take Control installed and active

0

No

1

Yes

result/[workstation|server] / patch

integer (1 or 0)

no

Is Patch Management installed and active

0

No

1

Yes

result/[workstation|server] / mav

integer (1 or 0)

no

Is Managed Anti-virus (VIPRE Engine) installed and active

0

No

1

Yes

result/[workstation|server] / mob

integer (1 or 0)

no

Is Managed Backup installed and active

0

No

1

Yes

result/[workstation|server] / systray

integer (1 or 0)

no

Is System Tray installed and active

0

No

1

Yes

result/[workstation|server] / mavbreck

integer (1 or 0)

no

Is Managed Anti-virus (Bitdefender Engine) installed and active

0

No

1

Yes
Example Associated Service Calls
Parameter Call URL Format
DeviceID list_devices_at_client

https://SERVER/api/?apikey=yourAPIkey&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
list_servers

https://SERVER/api/?apikey=yourAPIkey&service=list_servers&siteid=SITEID

list_workstations

https://SERVER/api/?apikey=yourAPIkey&service=list_workstations&siteid=SITEID
SiteID list_sites https://SERVER/api/?apikey=yourAPIkey&service=list_sites&clientid=CLIENTID
ClientID list_clients https://SERVER/api/?apikey=yourAPIkey&service=list_clients