Documentation | Spans

API Reference

Spans

SpansResource

Methods

client.spans.batch() ->

SpanBatchResponse

post/v5/spans/batch

Create Spans in Batch

client.spans.create() ->

Span

post/v5/spans

Create Span

client.spans.retrieve() ->

Span

get/v5/spans/{span_id}

Get Span

client.spans.update(, ) ->

Span

patch/v5/spans/{span_id}

Update Span

Parameters

span_id: str

end_timestamp: Optional[Union[str, datetime]]

(format: date-time)

metadata: Optional[Dict[str,

object

]]

name: Optional[str]

output: Optional[Dict[str,

object

]]

status: Optional[Literal["SUCCESS", "ERROR"]]

(default: "SUCCESS")

"SUCCESS"

"ERROR"

Returns

Span

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
span = client.spans.update(
    span_id="span_id",
)
print(span.id)

200Example

{
  "id": "id",
  "account_id": "account_id",
  "created_by_user_id": "created_by_user_id",
  "name": "name",
  "start_timestamp": "2019-12-27T18:11:19.117Z",
  "trace_id": "trace_id",
  "application_interaction_id": "application_interaction_id",
  "application_variant_id": "application_variant_id",
  "end_timestamp": "2019-12-27T18:11:19.117Z",
  "group_id": "group_id",
  "input": {
    "foo": "bar"
  },
  "metadata": {
    "foo": "bar"
  },
  "object": "span",
  "output": {
    "foo": "bar"
  },
  "parent_id": "parent_id",
  "status": "SUCCESS",
  "type": "TEXT_INPUT"
}

Domain types

class Span: ...