Documentation | Spans › Search And List Spans

Spans

spans

Methods

Create Span ->

Span

post/v5/spans

Create Span

Get Span ->

Span

get/v5/spans/{span_id}

Get Span

Update Span ->

Span

patch/v5/spans/{span_id}

Update Span

Create Spans In Batch -> { items, object }

post/v5/spans/batch

Create Spans in Batch

Upsert Spans In Batch -> { items, object }

put/v5/spans/batch

Upsert Spans in Batch

Search And List Spans -> CursorPage<

Span

post/v5/spans/search

Search and list spans

query Parameters

ending_before: string

Optional

from_ts: string

Optional

(format: date-time)

The starting (oldest) timestamp in ISO format.

limit: number

Optional

(maximum: 1000, minimum: 1, default: 100)

sort_by: string

Optional

sort_order:

Optional

(default: "asc")

"asc"

"desc"

starting_after: string

Optional

to_ts: string

Optional

(format: date-time)

The ending (most recent) timestamp in ISO format.

Response fields

has_more: boolean

Whether there are more items left to be fetched.

items: Array<

Span

total: number

The total of items that match the query. This is greater than or equal to the number of items returned.

limit: number

Optional

(default: 100)

The maximum number of items to return.

object: "list"

Optional

(default: "list")

Request example

curl https://api.egp.scale.com/v5/spans/search \
    -H 'Content-Type: application/json' \
    -H "x-api-key: $SGP_API_KEY" \
    -d '{}'

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "account_id": "account_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",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "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"
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

Domain types

Span = { id, account_id, name, 14 more... }

SpanStatus = "SUCCESS" | "ERROR" | "CANCELED"

SpanType = "TEXT_INPUT" | "TEXT_OUTPUT" | "COMPLETION_INPUT" | 22 more...