Screenshot via HTTP Request

Whether to document the current status of an application, for error analysis, data analysis or simply to share information. There are many reasons to take a screenshot and use it elsewhere.

Technically, you can extract such a screenshot directly from the Peakboard Box via the Peakboard API using an HTTP GET request.

Using the Peakboard API Swagger

Click on the [Swagger] button (2) in the [General] tab (1) of your Peakboard Box in the Peakboard Box settings to open the overview of the Peakboard API.

Peakboard API Swagger

Click on the [Authorize] button (1), enter the access data of your Peakboard Box (2) and confirm with [Authorize] (3) to authenticate yourself.


In the [RuntimeApiManagementService] area you will find the HTTP GET request /api/screenshot (1). Click on the [Try it out] button and then on [Execute] to test the function and display the request URL. The request URL (2) is as follows, using GET as the method:

[IP of the Peakboard Box]:40405/api/screenshot.

HTTP GET Request

Display screenshot on another Peakboard Box

You can now use the HTTP GET request to process the screenshot as you wish. For example, you can display the screenshot of your first Peakboard Box on a second Peakboard Box. This allows you to see directly from the second Peakboard Box whether the first Peakboard Box is running correctly.

To do this, simply create an image control (1) and add a new web resource (2).

Add image control

Enter the request URL (1) as the source URL and your access data for the Peakboard Box as Basic Authorization (2). Give the resource a name (3) and define a suitable reload interval (4).

Add web resource

If the visualization now changes on the first Peakboard Box, the change will be visible in the application on the second Peakboard Box after the reload interval has expired.

We are learning from you!

Did you find this article helpful?

Be enlightened!

Do you need more support?

Peakboard Youtube icon Visit our YouTube channel

Our numerous videos for beginners and advanced users explain exactly how to design your dashboard.

Peakboard Templates icon Visit the Peakboard Templates

Download our templates for various use cases for free.

Peakboard icon Visit www.peakboard.com

Find out all about Peakboard and browse our different use cases and success stories.