# List overview

URL: https://docs.hanzo.ai/docs/openapi/o11y/post-o11y-third-party-apis-overview-list

> Lists the external domains the instrumented services call, with request rate, error percentage and latency per domain.

`POST /v1/o11y/third-party-apis/overview/list`

> [O11y →](https://docs.hanzo.ai/docs/openapi/o11y) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                               |
| ------------- | ------------------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/o11y/third-party-apis/overview/list` |
| **Method**    | `POST`                                                        |
| **Operation** | `post_o11y_third-party-apis_overview_list`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                        |

Lists the external domains the instrumented services call, with
request rate, error percentage and latency per domain. Rows whose domain is
a bare IP address are dropped unless show\_ip asks for them.

## Request

14 fields, body `application/json` (required).

| Field                     | In   | Type                      | Required | Description                                                                       |
| ------------------------- | ---- | ------------------------- | -------- | --------------------------------------------------------------------------------- |
| `domain`                  | body | string                    | —        | Domain narrows the read to one external domain (the domain view requires it).     |
| `end`                     | body | integer (uint64)          | —        | End is the window's end, epoch milliseconds.                                      |
| `endpoint`                | body | string                    | —        | Endpoint narrows the domain view to one endpoint.                                 |
| `filter`                  | body | o11y.O11yDomainFilter     | —        |                                                                                   |
| `filter.expression`       | body | string                    | —        | Expression is the predicate, e.g. `http.status_code &gt;= 500`.                   |
| `groupBy`                 | body | o11y.O11yDomainGroupBy\[] | —        | GroupBy adds grouping columns to the result.                                      |
| `groupBy[].description`   | body | string                    | —        | Description describes the field, when known.                                      |
| `groupBy[].fieldContext`  | body | string                    | —        | FieldContext says which plane the field lives on, e.g. attribute, resource, span. |
| `groupBy[].fieldDataType` | body | string                    | —        | FieldDataType is the field's type: string, int64, float64 or bool.                |
| `groupBy[].name`          | body | string                    | —        | Name is the field's name.                                                         |
| `groupBy[].signal`        | body | string                    | —        | Signal is the telemetry signal the field belongs to, e.g. traces.                 |
| `groupBy[].unit`          | body | string                    | —        | Unit is the field's unit, when known.                                             |
| `show_ip`                 | body | boolean                   | —        | ShowIP keeps rows whose domain is a bare IP address; they are dropped otherwise.  |
| `start`                   | body | integer (uint64)          | —        | Start is the window's start, epoch milliseconds.                                  |

## Response

| Status    | Body                | Meaning           |
| --------- | ------------------- | ----------------- |
| `200`     | o11y.O11yDomainsOut | ok                |
| `202`     | Approval            | held for approval |
| `default` | problem-details     | refused           |

`200` body — 16 fields.

| Field                             | In   | Type                         | Always | Description                                               |
| --------------------------------- | ---- | ---------------------------- | ------ | --------------------------------------------------------- |
| `data`                            | body | o11y.O11yDomainsAnswer       | —      |                                                           |
| `data.data`                       | body | o11y.O11yDomainsData         | —      |                                                           |
| `data.data.results`               | body | any\[]                       | —      | Results is one entry per query.                           |
| `data.meta`                       | body | o11y.O11yQueryStats          | —      |                                                           |
| `data.meta.bytesScanned`          | body | integer (uint64)             | —      | BytesScanned is how many bytes the query read.            |
| `data.meta.durationMs`            | body | integer (uint64)             | —      | DurationMS is how long the query took, in milliseconds.   |
| `data.meta.rowsScanned`           | body | integer (uint64)             | —      | RowsScanned is how many rows the query read.              |
| `data.meta.stepIntervals`         | body | object                       | —      | StepIntervals is the step used per query, in seconds.     |
| `data.meta.stepIntervals.*`       | body | integer (uint64)             | —      |                                                           |
| `data.type`                       | body | string                       | —      | Type names the result shape: scalar, time\_series or raw. |
| `data.warning`                    | body | o11y.O11yQueryWarning        | —      |                                                           |
| `data.warning.message`            | body | string                       | —      | Message is the warning.                                   |
| `data.warning.url`                | body | string                       | —      | URL points at the relevant documentation.                 |
| `data.warning.warnings`           | body | o11y.O11yQueryWarningNote\[] | —      | Warnings carries additional notes.                        |
| `data.warning.warnings[].message` | body | string                       | —      | Message is the note.                                      |
| `status`                          | body | string                       | —      | Status is "success".                                      |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo o11y third-party-apis overview list
```

**SDK**

**.ts**

```ts
import { Configuration, O11yApi } from 'hanzoai';

const api = new O11yApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postO11yThird-party-apisOverviewList({ domain: "<domain>", end: 0 });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import O11yApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = O11yApi(client).post_o11y_third-party-apis_overview_list(domain="<domain>", end=0)
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.O11yAPI.PostO11yThird-party-apisOverviewList(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, o11y_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = o11y_api::post_o11y_third-party-apis_overview_list(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.O11yApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new O11yApi(client).postO11yThird-party-apisOverviewList();
```

The method above is the one at the current release of the document. `hanzoai@8.5.914` (npm) and `hanzoai@8.5.914` (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. [SDKs →](https://docs.hanzo.ai/docs/sdks)

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/o11y/third-party-apis/overview/list \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "domain": "<domain>",
       "end": 0
     }'
```

**MCP**

MCP reaches **o11y** through the `o11y` tool, which names its 307 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_o11y_autocomplete_aggregate_attributes"
         }
       }
     }'
```

---

[O11y API](https://docs.hanzo.ai/docs/openapi/o11y) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)
