Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Below table describes currently available report export endpoints and their differences on a higher level and allows you user to choose the best option for your the 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 reports with the options provided in the request body. Allows user to define more defined search criteria and only return matching reports.

Supported report fields

Field nameXML field pathName
IMEIblancco_hardware_report.system.imei@imei
System Serialblancco_hardware_report.system.serial@system_serial 
Erasure Stateblancco_erasure_report.erasures.erasure.state@erasure_state 
Custom fielduser_data.fields.{CUSTOM_FIELD_NAME}@custom-{CUSTOM_FIELD_NAME}
Code Block
titleExample JSON paylod
{
  "filter": {
    "date": {
      "gte": "2023-01-01T00:00:00Z"
    },
    "fields": [
      {
        "name": "@imei",
        "like": "123456789012345"
      },
      {
        "name": "@custom-my custom field",
        "like": "my custom field value"
      }
    ]
  },
  "category": "ERASURE",
  "format": "XML",
  "container": "ZIP"
}