Skip to content

Permanently delete span assessment

client.SpanAssessments.Delete(ctx, spanAssessmentID) (*SpanAssessmentDeleteResponse, error)
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
type SpanAssessmentDeleteResponse struct{…}
ID string
Deleted bool
Object SpanAssessmentDeleteResponseObjectOptional

Permanently delete span assessment

package main

import (
  "context"
  "fmt"

  "github.com/scaleapi/sgp-dev-go"
  "github.com/scaleapi/sgp-dev-go/option"
)

func main() {
  client := sgpdev.NewClient(
    option.WithAPIKey("My API Key"),
    option.WithAccountID("My Account ID"),
  )
  spanAssessment, err := client.SpanAssessments.Delete(context.TODO(), "span_assessment_id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", spanAssessment.ID)
}
{
  "id": "id",
  "deleted": true,
  "object": "span.assessment"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "span.assessment"
}