Exporting Categorized Records

All categorized records for a dataset can be exported through the API. This API call also has the option to export only manually classified records or records with a Tamr suggested classification. For details on how to test the API calls, see Testing the APIs.

Before getting the categorizations, be sure to Update Categorizations for the project.

The API endpoint to use to get the classifications is /procurement/datasets/{unifiedDatasetId}/categorizations

The fields for this GET request are

  • unifiedDatasetIdid, which is the ID of the dataset to get records for. To find the ID of a dataset from its name, use the API endpoint /datasets/named/{name}
  • type, an optional field that represents which type of categorizations to get. If included, it should either be MANUAL to get only records that were manually classified or SUGGESTED to get only records with a Tamr suggested classification.
  • tag, the ID of the categorization recipe (for example, recipe_10). To get the ID of a recipe, use the endpoint /recipes/all and find the information on the relevant recipe in the response.
  • taxonomyId, the ID of the taxonomy to get classifications from. To find the ID of taxonomy from its name, use the API endpoint /taxonomies/{name}

The call should resemble one of the following: /procurement/datasets/30/categorizations?type=MANUAL&tag=recipe_10&taxonomyId=2 or /procurement/datasets/30/categorizations?tag=recipe_10&taxonomyId=2


Did this page help you?