Documentation | Spans

API Reference

Spans

SpansResource

Methods

client.spans.batch() ->

SpanBatchResponse

post/v5/spans/batch

Create Spans in Batch

Parameters

items:

Iterable

[

Item

]

class ItemBaseSpanCreateRequest: ...

class ItemLegacyApplicationSpanCreateRequest: ...

Returns

class SpanBatchResponse:

items: List[

Span

]

object: Optional[Optional[Literal["list"]]]

(default: "list")

Request example

import os
from datetime import datetime
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
response = client.spans.batch(
    items=[{
        "name": "name",
        "start_timestamp": datetime.fromisoformat("2019-12-27T18:11:19.117"),
        "trace_id": "trace_id",
    }],
)
print(response.items)

200Example

{
  "items": [
    {
      "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"
    }
  ],
  "object": "list"
}

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

Domain types

class Span: ...