TAtarifflo
Classification

Get a classification batch

The batch's status and one page (1000 rows, page from 0) of its results once it completes.

Requires the API key scope classifications.

get/classifications/batch/{batchId}

Request

  • Base URL
    https://api.tarifflo.com/api/v2
  • URL
    https://api.tarifflo.com/api/v2/classifications/batch/{batchId}
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

batchIdstring required

Query parameters

pagestring

Response

Successful response

batchIdstring required
statusstring required
statestring required

SUBMITTED, RUNNING, COMPLETED or FAILED; results appear once COMPLETED.

expectedCountnumber required
shardsSettlednumber required
expectedShardsnumber required
pagenumber required
pageSizenumber required

Changes

No recorded changes to this operation across all 1 revision of this API.