# List Metrics — Eppo

> Retrieve all metrics defined in Eppo, including their names, IDs, descriptions, and minimum detectable effects. Use this tool to discover available metrics or find metric IDs needed when creating an experiment with Create Experiment…

- Key: `eppo-list-metrics`
- Type: Action (Read-only)
- Version: 0.0.2
- App: Eppo (`eppo`) — https://pipedream.com/apps/eppo.md
- This page (HTML): https://pipedream.com/apps/eppo/actions/list-metrics
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/eppo/actions/list-metrics/list-metrics.mjs

## Description

Retrieve all metrics defined in Eppo, including their names, IDs, descriptions, and minimum detectable effects. Use this tool to discover available metrics or find metric IDs needed when creating an experiment with **Create Experiment**. Filter by `entityId` to scope results to a specific entity type, or by `name` to find metrics by partial name match. Set `includeExperiments` to `true` to include associated experiments in the response (requires `limit` ≤ 10). Supports pagination via `limit` and `offset`. [See the documentation](https://eppo.cloud/api/docs#/Metrics/getMetrics)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `entityId` | `integer` | No | The numeric entity type ID this metric measures (e.g. user, session). Use List Metrics to find the entity_id from any existing metric — all metrics in the same workspace typically share the same entity ID. |
| `name` | `string` | No | Will return only metrics with a name that contains this value |
| `includeExperiments` | `boolean` | No | Will return all experiments associated with the metrics (requires limit to be 10 or less) |
| `limit` | `integer` | No | Maximum number of items to return per page (max 250). |
| `offset` | `integer` | No | Offset the number of items in response |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "eppo",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "eppo-list-metrics",
  arguments: {
    entityId: 10,
    name: "Name",
  },
})
```

**TypeScript**

```ts
import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "eppo-list-metrics",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    eppo: { authProvisionId: "apn_xxxxxxx" },
    entityId: 10,
    name: "Name",
  },
})

console.log(result)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "eppo-list-metrics",
    "configured_props": {
      "eppo": { "authProvisionId": "apn_xxxxxxx" },
      "entityId": 10,
      "name": "Name"
    }
  }'
```

---

- App: https://pipedream.com/apps/eppo.md · All apps: https://pipedream.com/apps