How to parse JSON output from a website using the REST Extractor plugin?

(This article uses the same website as example in a separate article: How to parse JSON output from a website using the Extractor plugin?)

In this example we will be monitoring and extracting information from the following website:
https://www.treasurydirect.gov/webapis/webapisecurities.htm

From the API, we have picked the Announced Endpoint to obtain 30 days data with JSON format output. The full URL would become:
https://www.treasurydirect.gov/TA_WS/securities/announced?format=json&days=30

1. Configure URL to monitor

The REST Extractor plugin can access web sites and parse JSON format output in one go. There is an URL field (highlighted in screen capture) which can directly input the web site to monitor.

2. Enter jq Query

Then at the Query field, user can simply enter the jq syntax to parse the JSON output.

We have used the following query in our example.

[.[] | {cusip: (.cusip + " - "+ .securityTerm), issueDate, maturityDate, securityType, announcementDate, auctionDate, interestRate, offeringAmount, securityTermDayMonth, securityTermWeekYear}]

3. Reorder the columns

We have picked to use cusip as the first column. This can be achieved with the Columns button on the right of the URL field.

We have attached the samplers in XML code at the bottom of the article, so users can experiment and reuse the configuration.

Further Reading

Users can refer to the User Guide and Technical Reference documents for REST Extractor plugin.

The documentation for jq can be found in Github.