> ## 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.

# EmailBison: Get Campaign Statssummary

> This endpoint retrieves the statistics of all your campaigns. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

This endpoint retrieves the statistics of all your campaigns.

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

## 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(
  'emailbison_get_campaign_statssummary',
  {
    "campaign_id": 123,
    "start_date": "2026-01-15T12:00:00Z",
    "end_date": "2026-01-15T12:00:00Z"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute emailbison_get_campaign_statssummary --input '{
  "campaign_id": 123,
  "start_date": "2026-01-15T12:00:00Z",
  "end_date": "2026-01-15T12:00:00Z"
}' --json
```

## 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": {
    "data": {
      "emails_sent": "jane.doe@example.com",
      "total_leads_contacted": "example",
      "opened": "example"
    }
  }
}
```

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

## Input reference

This endpoint retrieves the statistics of all your campaigns.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.campaign_id` | `integer` | Yes | — | The ID of the campaign. |
| `payload.start_date` | `string` | Yes | — | The start date to fetch stats. |
| `payload.end_date` | `string` | Yes | — | The end date to fetch stats. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This endpoint retrieves the statistics of all your campaigns.",
    "properties": {
      "campaign_id": {
        "type": "integer",
        "description": "The ID of the campaign."
      },
      "start_date": {
        "type": "string",
        "description": "The start date to fetch stats."
      },
      "end_date": {
        "type": "string",
        "description": "The end date to fetch stats."
      }
    },
    "required": [
      "campaign_id",
      "start_date",
      "end_date"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.data` | `object` | No | — | — |
| `result.data.data.emails_sent` | `string` | No | — | — |
| `result.data.data.total_leads_contacted` | `string` | No | — | — |
| `result.data.data.opened` | `string` | No | — | — |
| `result.data.data.opened_percentage` | `string` | No | — | — |
| `result.data.data.unique_opens_per_contact` | `string` | No | — | — |
| `result.data.data.unique_opens_per_contact_percentage` | `string` | No | — | — |
| `result.data.data.unique_replies_per_contact` | `string` | No | — | — |
| `result.data.data.unique_replies_per_contact_percentage` | `string` | No | — | — |
| `result.data.data.bounced` | `string` | No | — | — |
| `result.data.data.bounced_percentage` | `string` | No | — | — |
| `result.data.data.unsubscribed` | `string` | No | — | — |
| `result.data.data.unsubscribed_percentage` | `string` | No | — | — |
| `result.data.data.interested` | `string` | No | — | — |
| `result.data.data.interested_percentage` | `string` | No | — | — |
| `result.data.data.sequence_step_stats` | `array` | No | — | — |
| `result.data.data.sequence_step_stats[].sequence_step_id` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].email_subject` | `string` | No | — | — |
| `result.data.data.sequence_step_stats[].sent` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].leads_contacted` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].unique_opens` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].unique_replies` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].unsubscribed` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].bounced` | `integer` | No | — | — |
| `result.data.data.sequence_step_stats[].interested` | `integer` | 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": {
          "data": {
            "type": "object",
            "properties": {
              "emails_sent": {
                "type": "string"
              },
              "total_leads_contacted": {
                "type": "string"
              },
              "opened": {
                "type": "string"
              },
              "opened_percentage": {
                "type": "string"
              },
              "unique_opens_per_contact": {
                "type": "string"
              },
              "unique_opens_per_contact_percentage": {
                "type": "string"
              },
              "unique_replies_per_contact": {
                "type": "string"
              },
              "unique_replies_per_contact_percentage": {
                "type": "string"
              },
              "bounced": {
                "type": "string"
              },
              "bounced_percentage": {
                "type": "string"
              },
              "unsubscribed": {
                "type": "string"
              },
              "unsubscribed_percentage": {
                "type": "string"
              },
              "interested": {
                "type": "string"
              },
              "interested_percentage": {
                "type": "string"
              },
              "sequence_step_stats": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "sequence_step_id": {
                      "type": "integer"
                    },
                    "email_subject": {
                      "type": "string"
                    },
                    "sent": {
                      "type": "integer"
                    },
                    "leads_contacted": {
                      "type": "integer"
                    },
                    "unique_opens": {
                      "type": "integer"
                    },
                    "unique_replies": {
                      "type": "integer"
                    },
                    "unsubscribed": {
                      "type": "integer"
                    },
                    "bounced": {
                      "type": "integer"
                    },
                    "interested": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "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

* [EmailBison provider guide](https://deepline.com/docs/providers/emailbison/guide.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.