Get state information

Get information about the state of a request to export raw data.

Input data

Endpoint

https://tracker.my.com/api/raw/v1/export/get.json

Method

GET

Parameters

Name Value Description
idRawExport * Integer Unique export identifier

* - required parameters

Example query

/api/raw/v1/export/get.json?idRawExport=4

Responses

Success

A 200 response (OK) indicates success. It will include information on export according to status:

  • The In progress status shows the progress percentage and the isCancellable position (true if the cancel method is a success).

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idRawExport": "4",
        "status": "In progress",
        "progress": "64%",
        "isCancellable": false
      }
    }
  • The Error occurred status means that the export is interrupted and you can repeat the request.

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idRawExport": "4",
        "status": "Error occurred"
      }
    }
  • The User error occurred status means that the request under these conditions will never be complete. Because of the Too many lines in export error or the Too much export data error.

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idRawExport": "4",
        "status": "User error occurred",
        "errorMessage": "Too many lines in one export"
      }
    }
  • The Canceled by user status means that the request was canceled.

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idRawExport": "4",
        "status": "Canceled by user"
      }
    }
  • The Success status means that export is complete. You will see file list with timestamp (the files will then be unavailable).

    {
      "code": 200,
      "message": "Ok",
      "data": {
        "idRawExport": "4",
        "status": "Success!",
        "files": [
          {
            "link": "https://rawdata.hb.bizmrg.com/2021.01.01/4.payment.26c427ac8680888803ee05e34835b6dd.0.csv.gz",
            "timestampExpires": "1529746957"
          },
          {
            "link": "https://rawdata.hb.bizmrg.com/2021.01.01/4.payment.26c427ac8680888803ee05e34835b6dd.1.csv.gz",
            "timestampExpires": "1609502400"
          }
        ]
      }
    }

Errors

A 404 response indicates that the request is unavailable or could not be found.

{
  "code": 404,
  "message": "Not Found",
  "data": {
    "error": {
      "detail": "Raw export request not found"
    }
  }
}

Restrictions

A 403 response indicates that the method needs authorization. Maybe you made mistakes or forgot to send authorization data.

{
  "code": 403,
  "message": "Access denied",
  "data": null
}