Directly import API data into a spreadsheet (2024)

The API Key is associated with the Agent Key user, permissions and assigned Client Groups. If the Agent Key user has been assigned to a Client Group that contains either no Clients or a subset of Clients, APIcalls made using the generated APIKey can only return data associated with the Clients in the assigned Client Group.

Where security requires that the Agent Key user access to Client information within N-sight RMM must be restricted, we recommend that the Agent Key Dashboard Access is revoked.

You can query theData Extraction API URL to export data in an XML format to import into your choice of software for analysis and manipulation. You can choose several options to manipulate XML data such as a Microsoft Excel Power Query or using PivotTables.

In this section, we show the basic steps to import data from the Data Extraction API into Microsoft Excel, and provide steps for the 2010 edition.

We recommend you ensure the APIURLreturns data before you attempt to import data to a spreadsheet.

Due to the reduced feature set for Microsoft Excel online, not all these options may be available if you use the online version.

Import the APIdata as XML

To enable the Developer tab in the Excel ribbon:

  1. In Microsoft Excel, select the File tab, then go to Options > Customize Ribbon
  2. In the Customize the Ribbon drop-down menu select Main Tabs
  3. Select the Developer check box then OKto apply
  4. Directly import API data into a spreadsheet (1)

To create XMLMap:

  1. Open a blank workbook
  2. Go to the Developer tab and click on Source
  3. Click the XMLMaps button in the XMLSource pane on the right
  4. Click Add, enter the full APIURL including the APIKey and service call (Format example: https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks) in the File name then select Open
  5. Click OK to create a schema based on the XMLsource data when prompted by Excel, then OKagain in the XMLMaps dialog
  6. Directly import API data into a spreadsheet (2)

  7. To apply this schema to the workbook, hold "result" at the top of the XMLschema in the "XMLSource" pane then drag it to the target location in the spreadsheet (for example cell 'A1')
  8. Right-click the location to import the APIdata to (for example cell 'A2') from the context menu select XML >XMLImport

    Directly import API data into a spreadsheet (3)

  9. Enter the full APIURL including the APIKey and service call (Format example: https://SERVER/api/?apikey=yourAPIkey&service=list_failing_checks) then Open

    Excel connects to the API, retrieves the data and populates the workbook

  10. To refresh the information in the workbook go to the Data tab, and click Refresh All.

Microsoft Excel 2010

Directly import API data into a spreadsheet (4)

  1. Launch Microsoft Excel and create a blank workbook
  2. Click the Data tab then select From Web in the Get External Data section
  3. Directly import API data into a spreadsheet (5)

  4. Enter the API URL in the Address field of the New Web Query dialog and click Go
  5. The contents of the URL display in the dialog’s window and if everything is correct click Import

    Directly import API data into a spreadsheet (6)

    The download of data into Microsoft Excel begins (depending upon its configuration you may be required to accept an XML scheme informational message).

  6. In the Import Data dialog, select the location where you want to put the data

    Directly import API data into a spreadsheet (7)

  7. You can now manipulate and analyze the data using Microsoft Excel, for example with Pivot Tables or a Microsoft Excel Power Query.
Directly import API data into a spreadsheet (2024)
Top Articles
Latest Posts
Article information

Author: Terence Hammes MD

Last Updated:

Views: 5992

Rating: 4.9 / 5 (49 voted)

Reviews: 80% of readers found this page helpful

Author information

Name: Terence Hammes MD

Birthday: 1992-04-11

Address: Suite 408 9446 Mercy Mews, West Roxie, CT 04904

Phone: +50312511349175

Job: Product Consulting Liaison

Hobby: Jogging, Motor sports, Nordic skating, Jigsaw puzzles, Bird watching, Nordic skating, Sculpting

Introduction: My name is Terence Hammes MD, I am a inexpensive, energetic, jolly, faithful, cheerful, proud, rich person who loves writing and wants to share my knowledge and understanding with you.