Community
- Command Central
- MVP Program
- Monthly Mission
- Blogs
- Groups
- Events
- Media Vault
Products
- Observability
- Network Management
- Application Management
- IT Security
- IT Service Management
- System Management
- Database Management
Content Exchange
- SolarWinds Platform
- Server & Application Monitor
- Database Performance Analyzer
- Server Configuration Monitor
- Network Performance Monitor
- Network Configuration Manager
- SQL Sentry
- Web Help Desk
Free Tools & Trials

Is there an API with an example that I can use over REST that can basically pull a report in a CSV format

Basically I have a report that is emailed out in PDF and CSV format from SolarWinds to a couple of other user and platforms. Is there an API that can initiate the build of the report contents. I would have an agent that would make an REST API call to SolarWinds. I am also looking for a solid example preferably with Curl.

Thanks

Angel

Find more posts tagged with

Accepted answers

All comments

KMSigma.SWI

Because of the complexity of the reporting structure (charts, tables, custom HTML, etc.) it wouldn't be ideal to handle this via the Reports calls - even if they were possible (I'm not sure if it is).

Instead, I'd just try and figure out what data you want to use and write a SWQL Query and then call that from curl. Are you using an out-of-the-box report or something else? A sample of the report (or an export of the report in XML) may be helpful.

AngelSosa

Hello and thanks for responding, I am looking to see how to extract the S(W)QL query from a SolarWinds report I built on the SolarWinds platform. I don't know if the database query embeded into the report is SQL or SWQL. If I need to convert it and learn how thats done that's not issue for me. Prior to the post I was thinking about doing this in Curl. It also sounds the report definition is in XML format which I believe found on the server, where a bunch are stored. extracted the SQL statement and placed it inside of SWQL Studio but I strongly suspect the embedded SQL not SWQL. Is there documentation or cheat sheets how to transition from SQL to SWQL?

I need to gain access the query the report is using - I believe I found one of them in a file called 90_95_99th+Percentile+Traffic+Rate+-+Last+7+Days.xml

I am thinking a REST call over curl to the database server or to the SolarWinds Admin console

Where you thinking along those lines. ANd if you can offer additional information I would be very appreciative. of the help

Thanks

Angel

KMSigma.SWI

The SWQL query behind that report is:

-- Directly from Report
-- I did not author
SELECT Interfaces.InterfaceId
     , Nodes.NodeID
     , Nodes.Caption AS NodeName
     , Nodes.DetailsUrl AS NDetailsUrl
     , Nodes.VendorIcon AS Vendor
     , Interfaces.Caption AS Interface_Caption
     , Interfaces.InterfaceIcon AS Interface_Icon
     , Interfaces.DetailsUrl AS IDetailsUrl
     , Maxbps_In90
     , Maxbps_Out90
     , Maxbps_In95
     , Maxbps_Out95
     , Maxbps_In99
     , Maxbps_Out99
FROM Orion.Nodes
INNER JOIN Orion.NPM.Interfaces
     ON Nodes.NodeID = Interfaces.NodeID
INNER JOIN (
     SELECT OuterInterfaceTraffic.InterfaceID
          , (
               SELECT MAX(InAverageBps) AS maxInAverageBps
               FROM (
                    SELECT TOP 90 PERCENT InAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY InAveragebps ASC
                    )
               ) AS Maxbps_In90
          , (
               SELECT MAX(OutAverageBps) AS maxOutAverageBps
               FROM (
                    SELECT TOP 90 PERCENT OutAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY OutAveragebps ASC
                    )
               ) AS Maxbps_Out90
          , (
               SELECT MAX(InAveragebps) AS maxInMaxbps
               FROM (
                    SELECT TOP 95 PERCENT InAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY InMaxbps ASC
                    )
               ) AS Maxbps_In95
          , (
               SELECT MAX(OutAveragebps) AS maxOutMaxbps
               FROM (
                    SELECT TOP 95 PERCENT OutAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY OutMaxbps ASC
                    )
               ) AS Maxbps_Out95
          , (
               SELECT MAX(InAverageBps) AS maxInAverageBps
               FROM (
                    SELECT TOP 99 PERCENT InAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY InAveragebps ASC
                    )
               ) AS Maxbps_In99
          , (
               SELECT MAX(OutAverageBps) AS maxOutAverageBps
               FROM (
                    SELECT TOP 99 PERCENT OutAveragebps
                    FROM Orion.NPM.InterfaceTraffic
                    WHERE InterfaceID = OuterInterfaceTraffic.InterfaceID
                         AND DATETIME >= AddDay(- 7, GETUTCDATE())
                    ORDER BY OutAveragebps ASC
                    )
               ) AS Maxbps_Out99
     FROM Orion.NPM.InterfaceTraffic AS OuterInterfaceTraffic
     WHERE OuterInterfaceTraffic.DATETIME >= AddDay(- 7, GETUTCDATE())
     GROUP BY OuterInterfaceTraffic.InterfaceID
     ) TrafficStat
     ON Interfaces.InterfaceID = TrafficStat.InterfaceID

You can get this information like this:

curl.exe -k -u MyOrionUserName:MyOrionPassword https://MyOrionServer.Domain.Local:17778/SolarWinds/InformationService/v3/Json/Query?query=SELECT+Interfaces.InterfaceId+,+Nodes.NodeID+,+Nodes.Caption+AS+NodeName+,+Nodes.DetailsUrl+AS+NDetailsUrl+,+Nodes.VendorIcon+AS+Vendor+,+Interfaces.Caption+AS+Interface_Caption+,+Interfaces.InterfaceIcon+AS+Interface_Icon+,+Interfaces.DetailsUrl+AS+IDetailsUrl+,+Maxbps_In90+,+Maxbps_Out90+,+Maxbps_In95+,+Maxbps_Out95+,+Maxbps_In99+,+Maxbps_Out99+FROM+Orion.Nodes+INNER+JOIN+Orion.NPM.Interfaces+ON+Nodes.NodeID+=+Interfaces.NodeID+INNER+JOIN+(+SELECT+OuterInterfaceTraffic.InterfaceID+,+(+SELECT+MAX(InAverageBps)+AS+maxInAverageBps+FROM+(+SELECT+TOP+90+PERCENT+InAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+InAveragebps+ASC+)+)+AS+Maxbps_In90+,+(+SELECT+MAX(OutAverageBps)+AS+maxOutAverageBps+FROM+(+SELECT+TOP+90+PERCENT+OutAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+OutAveragebps+ASC+)+)+AS+Maxbps_Out90+,+(+SELECT+MAX(InAveragebps)+AS+maxInMaxbps+FROM+(+SELECT+TOP+95+PERCENT+InAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+InMaxbps+ASC+)+)+AS+Maxbps_In95+,+(+SELECT+MAX(OutAveragebps)+AS+maxOutMaxbps+FROM+(+SELECT+TOP+95+PERCENT+OutAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+OutMaxbps+ASC+)+)+AS+Maxbps_Out95+,+(+SELECT+MAX(InAverageBps)+AS+maxInAverageBps+FROM+(+SELECT+TOP+99+PERCENT+InAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+InAveragebps+ASC+)+)+AS+Maxbps_In99+,+(+SELECT+MAX(OutAverageBps)+AS+maxOutAverageBps+FROM+(+SELECT+TOP+99+PERCENT+OutAveragebps+FROM+Orion.NPM.InterfaceTraffic+WHERE+InterfaceID+=+OuterInterfaceTraffic.InterfaceID+AND+DATETIME+>=+AddDay(-+7,+GETUTCDATE())+ORDER+BY+OutAveragebps+ASC+)+)+AS+Maxbps_Out99+FROM+Orion.NPM.InterfaceTraffic+AS+OuterInterfaceTraffic+WHERE+OuterInterfaceTraffic.DATETIME+>=+AddDay(-+7,+GETUTCDATE())+GROUP+BY+OuterInterfaceTraffic.InterfaceID+)+TrafficStat+ON+Interfaces.InterfaceID+=+TrafficStat.InterfaceID

The data is returned in a large JSON output.

I used SWQL Studio to build this command for me:

AngelSosa

Hello,

I can follow your instructions and thank you. One issue that I have is as follows when I open the XML file that contains the report 90_95_99th+Percentile+Traffic+Rate+-+Last+7+Days.xml instead of ">=" as shown in your post the xml file contains ">" I understand if I need to do text editing or text conversions. On your end did you edit the query manually? Or is it stored correctly with ">=" on disk?. I looked at several xml files. And they match the pattern I am showing in my post. My version of SolarWinds is Orion Platform, WPM, IPAM, NCM, NPM, VMAN, SAM: 2020.2.5 © 1999-2022 SolarWinds Worldwide, LLC. All Rights Reserved. As an editor I use VIM and have used it for decades. I know its not doing any text conversions. What are your thoughts and let me know if you do any manual editing so that I can prepare? And thanks in advance.

Angel