User GuidesAPI ReferenceRelease Notes
Doc HomeHelp CenterLog In
API Reference

Export categorization labels from a categorization project

On success, this call returns all categorizations for a project, both verified and suggested by the machine learning model. Records are streamed out as new-line separated categorization records in the format:

{
  "recordId": "...",
  "verified" {
    "category": {
      "categoryId": "resourceId of category, e.g.unify://my-instance/v1/projects/1/taxonomy/categories/3",
      "path": [ /* string array representing the path of the category */ ],
      "reason": "optional description of why this categorization was verified"
    }
  },
  "suggested": {
    "scores": [{
      "category": {
        "categoryId": "resourceId of category, e.g.unify://my-instance/v1/projects/1/taxonomy/categories/3",
        "path": [/* string array representing the path of the category */]
      },
      "score": /* score given to this category suggestion*/,
      "aboveThreshold": /* true if the score is over the threshold set in the project's configuration */
    },
}

Where the scores repeat for every level in the category hierarchy suggested.

Language
Click Try It! to start a request and see the response here!