> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Resend: Segments Metrics

> Retrieve account or segment contact metrics (private beta). Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Retrieve account or segment contact metrics (private beta).

> [!NOTE]
>
> Tool ID: `resend_segments_metrics`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'resend_segments_metrics',
  {
    "metrics": "example",
    "dimensions": "segment",
    "segment_id": "segment_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline run resend_segments_metrics --input '{
  "metrics": "example",
  "dimensions": "segment",
  "segment_id": "segment_123"
}'
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "object": "metrics",
    "metrics": [
      "example"
    ],
    "dimensions": [
      "example"
    ]
  }
}
```

Use `deepline describe resend_segments_metrics --json` for the latest machine-readable contract.

## Input reference

Point-in-time contact counts, cached up to 15 minutes. Requires provider beta access. Counts contacts, not emails. no historical date range.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.metrics` | `string` | No | — | Comma-separated all\_contacts, subscribers, unsubscribers. omit for all. |
| `payload.dimensions` | `"segment"` | No | — | Include per-segment rows. omit for totals only. Allowed: `segment`. |
| `payload.segment_id` | `string` | No | — | Comma-separated segment IDs. omit for account totals. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Point-in-time contact counts, cached up to 15 minutes. Requires provider beta access. Counts contacts, not emails; no historical date range.",
    "properties": {
      "metrics": {
        "type": "string",
        "description": "Comma-separated all_contacts, subscribers, unsubscribers; omit for all."
      },
      "dimensions": {
        "type": "string",
        "description": "Include per-segment rows; omit for totals only.",
        "enum": [
          "segment"
        ]
      },
      "segment_id": {
        "type": "string",
        "description": "Comma-separated segment IDs; omit for account totals."
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.object` | `"metrics"` | No | — | Allowed: `metrics`. |
| `result.data.metrics` | `array` | No | — | — |
| `result.data.dimensions` | `array` | No | — | — |
| `result.data.totals` | `record` | No | — | — |
| `result.data.data` | `array` | No | — | — |
| `result.data.data[].id` | `string` | No | — | — |
| `result.data.data[].name` | `string` | No | — | — |
| `result.data.data[].all_contacts` | `number` | No | — | — |
| `result.data.data[].subscribers` | `number` | No | — | — |
| `result.data.data[].unsubscribers` | `number` | No | — | — |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "object": {
            "type": "string",
            "enum": [
              "metrics"
            ]
          },
          "metrics": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "dimensions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "totals": {
            "type": "object",
            "additionalProperties": {
              "type": "number"
            }
          },
          "data": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "all_contacts": {
                  "type": "number"
                },
                "subscribers": {
                  "type": "number"
                },
                "unsubscribers": {
                  "type": "number"
                }
              },
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Connect integrations](https://deepline.com/docs/integrations.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.