Discover what the trace filter fields hold

Discover what the trace filter fields hold in this project. Without field, every facet with its top values. With field, that field’s values, paged.

GET /api/v1/traces/facets

Discover what the trace filter fields hold

Python

import requests

url = "https://app.langwatch.ai/api/v1/traces/facets"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "facets": [
    {
      "key": "<string>",
      "kind": "categorical",
      "label": "<string>",
      "group": "trace",
      "topValues": [
        {
          "value": "<string>",
          "count": 123,
          "label": "<string>",
          "aggregates": {
            "passedCount": 123,
            "failedCount": 123,
            "erroredCount": 123,
            "scoreMin": 123,
            "scoreMax": 123,
            "hasScore": true,
            "distinctScores": 123,
            "hasLabel": true,
            "labelValues": [
              {
                "value": "<string>",
                "count": 123
              }
            ]
          },
          "eventMetrics": [
            {
              "key": "<string>",
              "values": [
                {
                  "value": "<string>",
                  "count": 123
                }
              ]
            }
          ]
        }
      ],
      "totalDistinct": 123
    }
  ],
  "pending": true
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Query Parameters

field · string

Required string length: 1 - 512

prefix · string

Maximum string length: 512

limit · integer · default: 50

Required range: 1 <= x <= 1000

offset · integer · default: 0

Required range: 0 <= x <= 9007199254740991

startDate · string

endDate · string

Response

200

application/json

Without field, every facet the project has with its top values and whether the payload is still being computed. With field, that field's values and counts plus the distinct total and whether more remain.

Option 1

Option 2

facets · object[] · required

Option 1

Option 2

Option 3

Show child attributes

pending · boolean · required

True when the payload is still being computed and what you have is the last committed one, possibly empty. Call again shortly.