Spans

Operations for the Spans service collection.

Language	Last Update
Python	v1.6.5
PowerShell
Go
TypeScript
Rust
Ruby

---

Table of Contents

Operation	Description
EntitiesSpansV1 entities_spans_v1	Retrieve spans for the provided ids.
QueriesSpansV1 queries_spans_v1	Query spans based on the provided filters.

---

EntitiesSpansV1

Retrieve spans for the provided ids.

Method GET

Route /agentic-studio/entities/spans/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 entities_spans_v1

Parameters

ids query · string or list of strings

IDs of entities to retrieve. Maximum of 1000 ids per request.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Spans

falcon = Spans(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.entities_spans_v1(ids=id_list)
print(response)

Operation ID

from falconpy import Spans

falcon = Spans(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.EntitiesSpansV1(ids=id_list)
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("EntitiesSpansV1",
                          ids=id_list)
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully retrieved

[
  {
    "attributes": {},
    "created_by": {},
    "duration_ms": 0,
    "end_time": "string",
    "error": {},
    "id": "string",
    "name": "string",
    "parent_span_id": "string",
    "span_id": "string",
    "span_type": "string",
    "start_time": "string",
    "status": "string",
    "trace_id": "string"
  }
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

404 Not Found

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

---

---

QueriesSpansV1

Query spans based on the provided filters.

Method GET

Route /agentic-studio/queries/spans/v1

Scope Charlotte AI Agent Definition: READ

PEP 8 queries_spans_v1

Parameters

offset query · integer

Starting index of overall result set from which to return ids.

limit query · integer

Number of IDs to return.

sort query · string

Possible order by fields. E.g.: ‘start_time|desc’.

filter query · string

FQL query specifying the filter parameters.

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

Python

PEP 8

from falconpy import Spans

falcon = Spans(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

response = falcon.queries_spans_v1(offset=integer,
                                   limit=integer,
                                   sort="string",
                                   filter="string")
print(response)

Operation ID

from falconpy import Spans

falcon = Spans(client_id=CLIENT_ID,
               client_secret=CLIENT_SECRET
               )

response = falcon.QueriesSpansV1(offset=integer,
                                 limit=integer,
                                 sort="string",
                                 filter="string")
print(response)

Uber

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

response = falcon.command("QueriesSpansV1",
                          offset=integer,
                          limit=integer,
                          sort="string",
                          filter="string")
print(response)

PowerShell

Examples coming soon.

Go

Examples coming soon.

TypeScript

Examples coming soon.

Rust

Examples coming soon.

Ruby

Examples coming soon.

Responses

200 Successfully retrieved

[
  "string"
]

400 Bad Request

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

403 Forbidden

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

429 Too Many Requests

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

500 Internal Server Error

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}