Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Created dateUpdated dateAffects versionFix version

 

 

Management PortalN/A

Table of Contents

This page will cover basics on how to utilize Management Portal APIs when exporting reports from the system.

More detailed examples and full descriptions for all available endpoint and their respective parameters can be found from API Guide available within the "Support"-tab in Management Portal.

Below table describes currently available report export endpoints and their differences on a higher level and allows you to choose the best option for your requirements.


EndpointMethodRequest FormatAllows multiple reports to be exported in a single requestAllows filtering for reportsDescription
Export reports/report/export/{uuid}GETN/A(error)(error)

Export a single report with its UUID.

Export reports (GET)/report/export?@imei={imei}GETN/A(tick)(error)

Export past month's reports with optional IMEI filtering.

Export reports (POST)/report/exportPOSTapplication/json(tick)(tick)Export reports with the filters/options provided in the request body.

Export Report

The most simple form of exporting a single report, requires the report UUID to be provided as part of the endpoint.

In the following examples replace {UUID} with a valid report UUID and {API_KEY} with the key string of your API key. If you don't have an API key yet, see more details from API Keys documentation.

Code Block
titleExample curl request
curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

By default the report is exported in XML format. Also PDF and JSON are supported, the format can be changed by defining "?format=" parameter as part of the request URL after the UUID. Supported values for the format parameter are XML, JSON and PDF.

Code Block
titleExample curl request in PDF fortmat
curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}?format=PDF" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

Export Report (GET)


Export Report (POST)