Permanently delete span assessment

client.spanAssessments.delete(, ?): SpanAssessmentDeleteResponse { id, deleted, object }

DELETE/v5/span-assessments/{span_assessment_id}

Permanently delete a span assessment by its identifier.

Only the assessment’s original creator, or an account admin or manager, may delete it; a request from any other identity returns 403. This is a hard delete: the assessment row is removed rather than archived, so it cannot be restored afterward. The response echoes the deleted assessment’s id. Returns 404 if no assessment with that id exists for the caller’s account.

ParametersExpand Collapse

spanAssessmentID: string

ReturnsExpand Collapse

SpanAssessmentDeleteResponse { id, deleted, object }

id: string

deleted: boolean

object?: "span.assessment"

Permanently delete span assessment

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 spanAssessment = await client.spanAssessments.delete('span_assessment_id');

console.log(spanAssessment.id);

{
  "id": "id",
  "deleted": true,
  "object": "span.assessment"
}

Returns Examples

{
  "id": "id",
  "deleted": true,
  "object": "span.assessment"
}