Skip to content

Get Evaluation Taxonomy

client.evaluations.retrieveTaxonomy(stringevaluationID, RequestOptionsoptions?): EvaluationRetrieveTaxonomyResponse
GET/v5/evaluations/{evaluation_id}/taxonomy

Get the taxonomy JSON for an evaluation’s contributor question tasks.

Returns the raw taxonomy document stored for the evaluation. Responds with a not-found error if the evaluation has no taxonomy.

ParametersExpand Collapse
evaluationID: string
ReturnsExpand Collapse
EvaluationRetrieveTaxonomyResponse = Record<string, unknown>

Get Evaluation Taxonomy

import SGPClient from 'scale-gp';

const client = new SGPClient({
  accountID: 'My Account ID',
  apiKey: process.env['SGP_API_KEY'], // This is the default and can be omitted
});

const response = await client.evaluations.retrieveTaxonomy('evaluation_id');

console.log(response);
{
  "foo": "bar"
}
Returns Examples
{
  "foo": "bar"
}