Query trace statistics for a harness

curl --request POST \
  --url https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_time_unix_seconds": 123,
  "queries": [
    {
      "name": "<string>",
      "filters": [
        {
          "value": "<string>"
        }
      ],
      "group_by": [],
      "limit": 1,
      "order": {}
    }
  ],
  "start_time_unix_seconds": 123
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    end_time_unix_seconds: 123,
    queries: [
      {
        name: '<string>',
        filters: [{value: '<string>'}],
        group_by: [],
        limit: 1,
        order: {}
      }
    ],
    start_time_unix_seconds: 123
  })
};

fetch('https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query"

payload = {
    "end_time_unix_seconds": 123,
    "queries": [
        {
            "name": "<string>",
            "filters": [{ "value": "<string>" }],
            "group_by": [],
            "limit": 1,
            "order": {}
        }
    ],
    "start_time_unix_seconds": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "request_type": "scalar",
    "results": [
      {
        "measure": "sessions",
        "query_name": "<string>",
        "unit": "<string>",
        "value": 123
      }
    ]
  },
  "meta": {
    "warnings": [
      "<string>"
    ]
  },
  "comparison": {
    "data": {
      "request_type": "scalar",
      "results": [
        {
          "measure": "sessions",
          "query_name": "<string>",
          "unit": "<string>",
          "value": 123
        }
      ]
    },
    "end_time_unix_seconds": 123,
    "start_time_unix_seconds": 123
  }
}

{
  "code": "invalid_json",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "alg_mismatch",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "access_denied",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "not_found",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unsupported_content_type",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "validation_failed",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "internal_error",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "auth_unavailable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "request_timeout",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

harness_id

string

required

Query Parameters

start_time_unix_seconds

integer<int64>

end_time_unix_seconds

integer<int64>

limit

integer<int32>

Required range: x >= 0

cursor

string

sort

string

user_id

string

session_status

string

Body

application/json

end_time_unix_seconds

integer<int64>

required

queries

object[]

required

Show child attributes

request_type

enum<string>

required

Available options:

scalar,

table,

time_series

start_time_unix_seconds

integer<int64>

required

bucket

null | enum<string>

Available options:

day,

week

compare

null | enum<string>

Available options:

none,

previous_period

workspace_id

string | null

Response

HTTP 200 response.

data

object

required

Option 1
Option 2
Option 3

Show child attributes

meta

object

required

Show child attributes

comparison

null | object

Show child attributes

Query trace statistics for a harness

curl --request POST \
  --url https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "end_time_unix_seconds": 123,
  "queries": [
    {
      "name": "<string>",
      "filters": [
        {
          "value": "<string>"
        }
      ],
      "group_by": [],
      "limit": 1,
      "order": {}
    }
  ],
  "start_time_unix_seconds": 123
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    end_time_unix_seconds: 123,
    queries: [
      {
        name: '<string>',
        filters: [{value: '<string>'}],
        group_by: [],
        limit: 1,
        order: {}
      }
    ],
    start_time_unix_seconds: 123
  })
};

fetch('https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://agentgateway.atlan.engineering/agent/v1/harnesses/{harness_id}/traces/stats/query"

payload = {
    "end_time_unix_seconds": 123,
    "queries": [
        {
            "name": "<string>",
            "filters": [{ "value": "<string>" }],
            "group_by": [],
            "limit": 1,
            "order": {}
        }
    ],
    "start_time_unix_seconds": 123
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "data": {
    "request_type": "scalar",
    "results": [
      {
        "measure": "sessions",
        "query_name": "<string>",
        "unit": "<string>",
        "value": 123
      }
    ]
  },
  "meta": {
    "warnings": [
      "<string>"
    ]
  },
  "comparison": {
    "data": {
      "request_type": "scalar",
      "results": [
        {
          "measure": "sessions",
          "query_name": "<string>",
          "unit": "<string>",
          "value": 123
        }
      ]
    },
    "end_time_unix_seconds": 123,
    "start_time_unix_seconds": 123
  }
}

{
  "code": "invalid_json",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "alg_mismatch",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "access_denied",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "not_found",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "unsupported_content_type",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "validation_failed",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "internal_error",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "auth_unavailable",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

{
  "code": "request_timeout",
  "detail": "<string>",
  "status": 1,
  "title": "<string>",
  "trace_id": "<string>"
}

Overview

CLI

SDK

Cookbooks

Operate safely

API reference

Query trace statistics for a harness

Authorizations

Path Parameters

Query Parameters

Body

Response