New Question
 
 
PRTG Network Monitor

Intuitive to Use.
Easy to manage.

200.000 administrators have chosen PRTG to monitor their network. Find out how you can reduce cost, increase QoS and ease planning, as well.

Free PRTG
Download >>

 

What is this?

This knowledgebase contains questions and answers about PRTG Network Monitor and network monitoring in general. You are invited to get involved by asking and answering questions!

Learn more

 

Top Tags


View all Tags


How can I export raw sensor data automatically from PRTG?

Votes:

0

Your Vote:

Up

Down

I want to export the monitoring data of PRTG to a CSV or XML file on a daily basis. This way, I can analyze the data in my own software or import it to Microsoft Excel, for example.

automation csv export google-code historic-data prtg raw-data sensor-data tools xml

Created on Feb 3, 2010 9:28:41 AM by  Daniel Zobel [Paessler Support]

Last change on May 6, 2019 12:18:40 PM by  Maike Behnsen [Paessler Support]



Best Answer

Accepted Answer

Votes:

1

Your Vote:

Up

Down

This article applies to PRTG Network Monitor 19 or later

Exporting Historic Sensor Data into CSV or XML Files with the PRTG API

The PRTG API allows you to export historic sensor data into CSV or XML files. This is useful if you need sensor data in a format that allows you to view your own statistics in external programs or for additional computations.

The API documentation contains all of the information that you need to build your queries. You can run API calls from a supported browser in URL format. The URL call must include the PRTG website name and credentials, for example: https://<your-PRTG-server>/api/historicdata.xml?....&username=myuser&passhash=mypasshash

API Calls for Historic Data in CSV or XML Format

The following API calls give you historic data tables, either in XML or CSV format.

Remarks

  • The authentication with username and passhash (or username and password) must always be included in each request by using the username and passhash (or username and password) parameters. You can find the passhash in the PRTG web interface:
    • Select Setup | Account Settings | My Account from the PRTG main menu.
    • Click the Show passhash button.
  • You must supply the object ID of a sensor as well as a start date/time sdate and end date/time edate to get the raw data table. You can find the object ID on a sensor’s overview tab or by hovering over the sensor in the device tree, for example.

CSV Format /api/historicdata.csv?id=objectid&avg=0&sdate=2018-01-20-00-00-00&edate=2018-01-21-00-00-00&username=myuser&passhash=mypasshash XML Format /api/historicdata.xml?id=objectid&avg=0&sdate=2017-01-20-00-00-00&edate=2017-01-21-00-00-00&username=myuser&passhash=mypasshash

Example

You can use the following example call to query historic data for a Core Health sensor with ID #1002 in CSV format /api/historicdata.csv?id=1002&avg=0&sdate=2018-02-01-00-00-00&edate=2018-02-15-00-00-00&username=myuser&passhash=mypasshash The avg (average) is 0 so raw data is displayed. The sdate is February 1st, 2018 at 12 A.M and the edate is February 15th, 2018 at 12 A.M. The result is a spreadsheet (CSV) file where data of each sensor channel is represented in an individual column.

Common Parameters for Historic Data API Calls

You can use the following parameters for the historic graphs and data tables:

ParameterDescriptionPossible Values
idID of the specific sensorinteger value
sdateStart of the time span (date and time)yyyy-mm-dd-hh-mm-ss
edateEnd of the time span (date and time)yyyy-mm-dd-hh-mm-ss
avgAverage interval in seconds; use 0 to download raw data (= results of all single monitoring requests)integer value
width/heightWidth and height of the graph in pixelsinteger value
graphstylingbaseFontSize='x' sets the size of the font, showLegend='x' enables (1) or disables (0) the graph legendbaseFontSize='x'%20showLegend='x'

Historic Data Query Builder

The query builder tool allows you to experiment with API calls. The tool automatically builds and tests your desired queries. You can find the tool in the PRTG web interface under Setup | PRTG API | Live Data, section PRTG HTTP API: XML Table Query Builder.

Detailed HTTP API Documentation

You can find detailed documentation on all HTTP API functions in the PRTG Manual: Application Programming Interface (API) Definition.

Automatic Export

If you want to automatically export historic data of several sensors at once, you can use the CSVExport command line tool. It allows you to export data into both CSV and XML files. See PRTG Tools Family for more information.

Limitations of the PRTG API for Historic Data

There are some limitations to prevent potential server overload when you query historic sensor data via the PRTG API.

  • Maximum 40 days of data for raw data requests
  • Maximum 500 days of data per API request for averages. If you try to use a larger time span than 500 days, PRTG will reduce it to 365 days automatically
  • Maximum 5 API calls per minute

See Also

Created on Apr 5, 2018 1:36:41 PM by  Brandy Greger [Paessler Support]

Last change on May 7, 2019 7:38:22 AM by  Brandy Greger [Paessler Support]



19 Replies

Votes:

0

Your Vote:

Up

Down

This article applies to PRTG Network Monitor Version 12 or later, as well as to previous (deprecated) versions

HowTo: Automatically Exporting PRTG's Raw Monitoring Data Into Daily CSV or XML Files

With PRTG Network Monitor, you can analyze your sensor data in various ways. Exhaustive reports for your whole network can be generated as well as historic data reports for single sensors. Still, there are people who just need the data of a sensor in a convenient format to do their own statistics in external programs or to use Excel to do additional computations based on the monitoring data. That is why we have included a XML and CSV export function in PRTG.

This function of the web interface is handy to export data every few days. But if you need daily data for one or more sensors an automatic solution is more comfortable. With the CSVExport command line tool finally there is a way to export data of many PRTG sensors with one single line of script! You can use it as an on-demand tool or combine it with Windows task scheduler. Don't be confused by the name - CSVExport is capable of both XML and CSV data export!

Getting Started

To try it out, download CSVExport from PRTG Tools Family and unpack it.

To run the tool you must supply following command line parameters:

  • PRTG username (option -pu).
  • PRTG password (option -pp).
  • The IP address or hostname of the PRTG web interface (option -ps).
  • The sensor ID (or a list of IDs) of the sensor(s) you want to export the data for (option -s). You can look up a sensor's ID under its detail overview page from within the PRTG web interface. The ID is the number written in parentheses behind the sensor name. By the way, the ID is also part of the sensor's webpage URL.

For example, a simple call may look like this:

csvexport -pu=prtgadmin -pp=prtgadmin -ps=192.168.0.10 -s=1001

This command line writes yesterday's data of the sensor "Probe Health" (ID 1001) into a CSV file in the directory where CSVExport is started. If a file already exists, it is not overwritten, but a number is appended to the file name. If you run this command once every day using scheduled tasks you will get a daily CSV file for the sensor 1001.

A big advantage of this tool is that you can export the data of many sensors with one single call. To do so, you only have to look up the IDs and enter them - separated by commas - behind the "-s" parameter. In this case, you will get a separate file for each sensor.

Advanced Options

With optional parameters, you can define a start and end date of the data you want to export or enter a different target file location and credentials, if necessary. You can also change file format to XML and even combine the data of multiple sensors into one file. Please see the manual that comes with the tool's download for a good description of all advanced options.

Notes

This tool was written by PRTG Tools Family (which is not associated with Paessler). Thanks for sharing it with the community! All Google Code tools have not been created and published by Paessler AG, so we are not able to support them officially.

More

If you have trouble opening the CSV files in Excel, please see The Comma and Semicolon Issue in Excel Due to Regional Settings for Europe

Created on Feb 3, 2010 9:31:56 AM by  Daniel Zobel [Paessler Support]

Last change on Mar 15, 2018 3:49:16 PM by  Arne Seifert [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Hi,

I keep getting this error when I run this tool against our PRTG instance:

C:\My Documents\Downloads\PTF.CSVExport>CSVExport.exe -pu=<hidden> -pp=<hidden> -ps=http :<ip address hidden>:8080 -s=4544 -f:C:\Tools

Processing sensor 4544 Getting data for sensor 4544 0:The remote server returned an error: (404) Not Found.

Press any key to continue

Can you please let me know how can I fix this problem? I am able to hit this server through browser without any problem.

Thanks, Amar

Created on Jul 9, 2010 11:04:22 PM by  amargoradia (0) 1

Last change on May 10, 2012 12:27:16 PM by  Manischa Mittal [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Yes, I do know is somewhat late for you, but it may help others.

I first tried CSVExport.exe -pu=prtgadmin -pp=prtgadmin -ps=xx.xx.xx.xx -s=1003 I got a 404 too

At Home / PRTG Status in System Settings, it stated: web server url: xx.xx.xx.xx web server IPs: xx.xx.xx.xx web server ports: 8081 I suppose that 8081 is because I have a WSUS (using port 80)

I then tried CSVExport.exe -pu=prtgadmin -pp=prtgadmin -ps=xx.xx.xx.xx:8081 -s=1003 I don't get a 404 but a "Cannot connect with remote server". And just the same with -ps= xx.xx.xx.xx:8081

At last, I repeated the address wich appears when I click "PRTG Network Monitor" (web GUI) CSVExport.exe -pu=prtgadmin -pp=prtgadmin -ps=xx.xx.xx.xx -s=1003 (with HTTPS) and _success_ ! :-)

HIH somebody

Created on Oct 26, 2010 5:41:18 PM by  rodeca (0)

Last change on May 10, 2012 12:26:34 PM by  Manischa Mittal [Paessler Support]



Votes:

0

Your Vote:

Up

Down

hi, i'm using CSVExport to export my data in csv. currently i'm using sensor method. my problem now is i unable to set the sensor to be executed at time that i already set. can any one help me on this.

Created on Jun 14, 2013 7:20:47 AM by  Chuan Hoa Yau (0)



Votes:

0

Your Vote:

Up

Down

Can not get this program to work. Links in KB are dead.

Try this csvexport -pu=prtgadmin -pp=(hidden but confirmed) -ps=https://xx.xxx.xxx.xxx -s=2465 -to=60 -f=C:\Tools

Get the following: The remote server returned an error: (400) Bad Request.

Please help!!! Getting this working will be the deciding factor of it we renew or not.

Created on May 14, 2014 12:49:59 PM by  Butters5191 (0) 1



Votes:

0

Your Vote:

Up

Down

Please check the url that is used for the –ps= parameter. Make sure that you are using the correct protocol and port number. Typing this url in your web browser should present you with the PRTG login page.

Created on May 15, 2014 10:30:19 AM by  PRTG Tools Family [prtgtoolsfamily.com] (12,885) 3 4



Votes:

0

Your Vote:

Up

Down

Dear Daniel Zobel, I downloaded CSVExport.exe from PRTG Tool Family, and it worked OK with 2-3 sensors. But, I had some problems:

	1. I can't export CSV file with a Router (Probe) sensor (has IP and contains multi-sensors) , eg: ID=12772, the output has error.
		CSVExport.exe -pu=prtgadmin -pp=********
-ps=<my_server_IP_address>:8888 -s=12772 -av=300
		==> 13.4.1.13
			Processing sensor 12772
			Retrieving sensor historic data
			The remote server returned an error: (400) Bad Request.
	2. When I used the optional parameter -fc ==> It was not ok. The Output command ok, but the .csv file was empty (but data's size >17KB)
		CSVExport.exe -pu=prtgadmin -pp=********
-ps=<my_server_IP_address>:8888 -s=13018 -fc=DateTime
		==> 13.4.1.13
			
			Processing sensor 13018
			Retrieving sensor historic data
			Exporting to CSV

			5526:Completed at 26-05-2014 17.36	
		==> What's wrong here? 

And, Can I get the file of PRTG Network Monitor to Display All sensor ID and the their Description? Thank you very much and have a nice day!

Created on May 27, 2014 7:58:51 AM by  tqkhuong (0)

Last change on May 27, 2014 9:21:09 AM by  Torsten Lindner [Paessler Support]



Votes:

0

Your Vote:

Up

Down

You can only access data on a per-sensor basis. It is not possible to "download" the historic data from a device and so all the child sensors. You need to do this one-by-one for each sensor.
To get a list of all sensors and their IDs you can use the API. Please see "Setup"->"PRTG API"->"Live Data" for the details.

Created on May 27, 2014 9:22:39 AM by  Torsten Lindner [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Dear Torsten Lindner, And what's about the parameter "-fc=..."? I want some fields: datetime, traffic total, traffic in, traffic out. How can I use it? Thank you for helping me.

Created on May 27, 2014 10:37:55 AM by  tqkhuong (0)



Votes:

0

Your Vote:

Up

Down

This is something you need to consult the provider of the tool directly about: http://www.prtgtoolsfamily.com

Created on May 27, 2014 11:15:55 AM by  Torsten Lindner [Paessler Support]

Last change on May 27, 2014 11:16:09 AM by  Torsten Lindner [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Where I can download CVSexport tool? Pages http://www.prtgtoolsfamily.com not working now!

Created on Mar 3, 2015 2:00:29 PM by  esmiran (0)



Votes:

0

Your Vote:

Up

Down

Since January 2015 there is a new tool called PRTG Data Extractor BETA that allows you to export your PRTG monitoring data to a SQL Server for further reporting/analysis.

Head to this article for details.

Feedback on the tool is welcome.

Update: Please be aware that we won't be continuing/supporting the PRTG Data Extractor any longer.

Created on Jun 1, 2015 1:31:31 PM by  Luciano Lingnau [Paessler Support]

Last change on Mar 14, 2018 1:50:33 PM by  Gerald Schoch [Paessler Support]



Votes:

0

Your Vote:

Up

Down

What about PDF export? Is it possible? Is it going to be possible in future versions?

Created on Oct 14, 2015 9:30:17 AM by  Aineias Matis (20) 1



Votes:

0

Your Vote:

Up

Down

Hello Aineias Matis,
The reports feature within PRTG is able to generate PDF reports for any sensor type with 1 minute interval readings. Please visit the manual page for more details:

Best Regards,

Created on Oct 14, 2015 10:28:44 AM by  Luciano Lingnau [Paessler Support]



Votes:

0

Your Vote:

Up

Down

I have downloaded the software, but where to use it? Where do you enter these commands?

Created on Mar 15, 2016 8:29:56 AM by  Peter Parker (0) 1



Votes:

0

Your Vote:

Up

Down

Hello Peter,
thank you for contacting us.

Please review this. You need to download csvexport first, then you'll be able to run the application passing the appropriate parameters.

Best Regards,

Created on Mar 15, 2016 9:07:52 AM by  Luciano Lingnau [Paessler Support]



Votes:

0

Your Vote:

Up

Down

Can CSVExport automatically export PRTG's Raw Monitoring Data Into minutely CSV or XML Files (every Minute)? what about shorter time? for example each 15 seconds.

Created on Apr 17, 2016 7:22:34 AM by  Nastaran (0)



Votes:

0

Your Vote:

Up

Down

Hello Nastaran,
thank you for your post.

If you need to query "live" data from PRTG, please check PRTG's HTTP API. Please note that low scanning intervals (smaller than 30 seconds) may have adverse performance implications on large setups, we recommend using scanning intervals above 30 seconds, and using such interval you should also only query the API every 30 seconds.

Please note that there are two distinct queries which can be used, one for the "current" value and one for historic data, you could for instance always query all values for the last 5 minutes every 5 minutes or so.

Best Regards,

Created on Apr 19, 2016 8:01:05 AM by  Luciano Lingnau [Paessler Support]



Accepted Answer

Votes:

1

Your Vote:

Up

Down

This article applies to PRTG Network Monitor 19 or later

Exporting Historic Sensor Data into CSV or XML Files with the PRTG API

The PRTG API allows you to export historic sensor data into CSV or XML files. This is useful if you need sensor data in a format that allows you to view your own statistics in external programs or for additional computations.

The API documentation contains all of the information that you need to build your queries. You can run API calls from a supported browser in URL format. The URL call must include the PRTG website name and credentials, for example: https://<your-PRTG-server>/api/historicdata.xml?....&username=myuser&passhash=mypasshash

API Calls for Historic Data in CSV or XML Format

The following API calls give you historic data tables, either in XML or CSV format.

Remarks

  • The authentication with username and passhash (or username and password) must always be included in each request by using the username and passhash (or username and password) parameters. You can find the passhash in the PRTG web interface:
    • Select Setup | Account Settings | My Account from the PRTG main menu.
    • Click the Show passhash button.
  • You must supply the object ID of a sensor as well as a start date/time sdate and end date/time edate to get the raw data table. You can find the object ID on a sensor’s overview tab or by hovering over the sensor in the device tree, for example.

CSV Format /api/historicdata.csv?id=objectid&avg=0&sdate=2018-01-20-00-00-00&edate=2018-01-21-00-00-00&username=myuser&passhash=mypasshash XML Format /api/historicdata.xml?id=objectid&avg=0&sdate=2017-01-20-00-00-00&edate=2017-01-21-00-00-00&username=myuser&passhash=mypasshash

Example

You can use the following example call to query historic data for a Core Health sensor with ID #1002 in CSV format /api/historicdata.csv?id=1002&avg=0&sdate=2018-02-01-00-00-00&edate=2018-02-15-00-00-00&username=myuser&passhash=mypasshash The avg (average) is 0 so raw data is displayed. The sdate is February 1st, 2018 at 12 A.M and the edate is February 15th, 2018 at 12 A.M. The result is a spreadsheet (CSV) file where data of each sensor channel is represented in an individual column.

Common Parameters for Historic Data API Calls

You can use the following parameters for the historic graphs and data tables:

ParameterDescriptionPossible Values
idID of the specific sensorinteger value
sdateStart of the time span (date and time)yyyy-mm-dd-hh-mm-ss
edateEnd of the time span (date and time)yyyy-mm-dd-hh-mm-ss
avgAverage interval in seconds; use 0 to download raw data (= results of all single monitoring requests)integer value
width/heightWidth and height of the graph in pixelsinteger value
graphstylingbaseFontSize='x' sets the size of the font, showLegend='x' enables (1) or disables (0) the graph legendbaseFontSize='x'%20showLegend='x'

Historic Data Query Builder

The query builder tool allows you to experiment with API calls. The tool automatically builds and tests your desired queries. You can find the tool in the PRTG web interface under Setup | PRTG API | Live Data, section PRTG HTTP API: XML Table Query Builder.

Detailed HTTP API Documentation

You can find detailed documentation on all HTTP API functions in the PRTG Manual: Application Programming Interface (API) Definition.

Automatic Export

If you want to automatically export historic data of several sensors at once, you can use the CSVExport command line tool. It allows you to export data into both CSV and XML files. See PRTG Tools Family for more information.

Limitations of the PRTG API for Historic Data

There are some limitations to prevent potential server overload when you query historic sensor data via the PRTG API.

  • Maximum 40 days of data for raw data requests
  • Maximum 500 days of data per API request for averages. If you try to use a larger time span than 500 days, PRTG will reduce it to 365 days automatically
  • Maximum 5 API calls per minute

See Also

Created on Apr 5, 2018 1:36:41 PM by  Brandy Greger [Paessler Support]

Last change on May 7, 2019 7:38:22 AM by  Brandy Greger [Paessler Support]



Please log in or register to enter your reply.


Disclaimer: The information in the Paessler Knowledge Base comes without warranty of any kind. Use at your own risk. Before applying any instructions please exercise proper system administrator housekeeping. You must make sure that a proper backup of all your data is available.