Documentation | Span Assessments › List Span Assessments

Span Assessments

span_assessments

Methods

Create Span Assessment ->

SpanAssessment

post/v5/span-assessments

Create new assessment for a span (comment, rating, approval, rubric, overwrite, or metadata)

Get Span Assessment ->

SpanAssessment

get/v5/span-assessments/{span_assessment_id}

Get an assessment by ID

List Span Assessments -> APIListPage<

SpanAssessment

get/v5/span-assessments

Get all assessments for a specific span or trace, optionally filtered by assessment type

query Parameters

assessment_type:

AssessmentType

Optional

Filter by assessment type

span_id: string

Optional

Filter by span ID. Either span_id or trace_id must be provided as a query parameter.

trace_id: string

Optional

Filter by trace ID. Either span_id or trace_id must be provided as a query parameter.

Response fields

items: Array<

SpanAssessment

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/span-assessments \
    -H "x-api-key: $SGP_API_KEY"

200Example

{
  "items": [
    {
      "assessment_id": "assessment_id",
      "assessment_type": "comment",
      "created_by": "created_by",
      "span_id": "span_id",
      "trace_id": "trace_id",
      "account_id": "account_id",
      "approval": "approved",
      "comment": "comment",
      "created_at": "2019-12-27T18:11:19.117Z",
      "metadata": {
        "foo": "bar"
      },
      "object": "span.assessment",
      "overwrite": {
        "foo": "bar"
      },
      "rating": 1,
      "rubric": {
        "foo": "string"
      },
      "updated_at": "2019-12-27T18:11:19.117Z"
    }
  ],
  "object": "list"
}

Update Span Assessment ->

SpanAssessment

patch/v5/span-assessments/{span_assessment_id}

Update existing assessment (only by the original creator)

Delete Span Assessment -> { id, deleted, object }

delete/v5/span-assessments/{span_assessment_id}

Delete assessment

Domain types

ApprovalStatus = "approved" | "rejected"

Status options for approval assessments

AssessmentType = "comment" | "rating" | "approval" | 3 more...

Types of assessments that can be provided

SpanAssessment = { assessment_id, assessment_type, created_by, 12 more... }

Response model for span assessment