gtt logo

REST API

version 2502

GTT Batch Reports

The following services are available

List the Available Batch Reports

To get the list of available GTT Batch reports use:

https://www.globaltradetracker.com/api/rest/batch/list

Supported method: GET

Parameter:

id
Comma or semicolon separated list of report ids.

If specified, the response will contain the information about the reports with those ids.
Otherwise, the information about all reports available to the user will be returned.

Response: JSON

Batch Report Status

To get the current status for one or several Batch reports use:

https://www.globaltradetracker.com/api/rest/batch/status

Supported method: GET

Parameter:

id
Comma or semicolon separated list of report ids.
This parameter is required. One of several report ids must be specified.

Response: JSON

The possible status values are:

IN_PROGRESS
The report is currently being processed.
READY
The report was successfully generated and is ready to be downloaded.
NO_DATA
The report was successfully generated, but it contains no data.
ERROR
The report was not generated because of error. In this case the field statusDetails contains the error description.

Generate Batch Report

To start the generation of the Batch reports use:

https://www.globaltradetracker.com/api/rest/batch/generate

Supported methods: GET, POST

Parameter:

id
Id of the report
This parameter is required. Exactly one report id must be specified.

Response: JSON

The report generation status is returned.
The file might not be ready for download immediately after the execution of this request.
The report generation progress can be monitored by checking the report status.

Download Batch Report

To download the generated Batch report file use:

https://www.globaltradetracker.com/api/rest/batch/download

Supported method: GET

Parameter:

id
Id of the report
This parameter is required. Exactly one report id must be specified.
format
Format of the report file. Possible values are:
  • JSON
  • CSV
  • XLSX - Microsoft Excel Open XML format
If this parameter is not specified, the default value is JSON.