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

# HeyReach: Get Overall Stats

> Reading overall HeyReach stats with sender/campaign filters. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Reading overall HeyReach stats with sender/campaign filters.

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

## 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(
  'heyreach_get_overall_stats',
  {
    "account_ids": [
      123
    ],
    "campaign_ids": [
      123
    ],
    "from": "2026-01-15T12:00:00Z"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute heyreach_get_overall_stats --input '{
  "account_ids": [
    123
  ],
  "campaign_ids": [
    123
  ],
  "from": "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"]}}
{
  "status": "example",
  "result": {
    "byDayStats": {
      "2024-12-17T00:00:00Z": {
        "profileViews": 123,
        "postLikes": 123,
        "follows": 123,
        "messagesSent": 123,
        "totalMessageStarted": 123,
        "totalMessageReplies": 123,
        "inmailMessagesSent": 123,
        "totalInmailStarted": 123,
        "totalInmailReplies": 123,
        "connectionsSent": 123,
        "connectionsAccepted": 123,
        "messageReplyRate": 123,
        "inMailReplyRate": 123,
        "connectionAcceptanceRate": 123
      },
      "2024-12-18T00:00:00Z": {
        "profileViews": 123,
        "postLikes": 123,
        "follows": 123,
        "messagesSent": 123,
        "totalMessageStarted": 123,
        "totalMessageReplies": 123,
        "inmailMessagesSent": 123,
        "totalInmailStarted": 123,
        "totalInmailReplies": 123,
        "connectionsSent": 123,
        "connectionsAccepted": 123,
        "messageReplyRate": 123,
        "inMailReplyRate": 123,
        "connectionAcceptanceRate": 123
      }
    },
    "overallStats": {
      "profileViews": 123,
      "postLikes": 123,
      "follows": 123,
      "messagesSent": 123,
      "totalMessageStarted": 123,
      "totalMessageReplies": 123,
      "inmailMessagesSent": 123,
      "totalInmailStarted": 123,
      "totalInmailReplies": 123,
      "connectionsSent": 123,
      "connectionsAccepted": 123,
      "messageReplyRate": 123,
      "inMailReplyRate": 123,
      "connectionAcceptanceRate": 123
    }
  }
}
```

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

## Input reference

HeyReach get overall stats input.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.account_ids` | `array` | No | — | — |
| `payload.campaign_ids` | `array` | No | — | — |
| `payload.from` | `string` | No | — | Format: `date-time`. |
| `payload.to` | `string` | No | — | Format: `date-time`. |
| `payload.additional_filters` | `record` | No | — | — |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "HeyReach get overall stats input.",
    "properties": {
      "account_ids": {
        "type": "array",
        "items": {
          "description": "Numeric id as integer or numeric string.",
          "anyOf": [
            {
              "type": "integer",
              "minimum": 1
            },
            {
              "type": "string",
              "minLength": 1,
              "pattern": "^\\d+$"
            }
          ]
        }
      },
      "campaign_ids": {
        "type": "array",
        "items": {
          "description": "Numeric id as integer or numeric string.",
          "anyOf": [
            {
              "type": "integer",
              "minimum": 1
            },
            {
              "type": "string",
              "minLength": 1,
              "pattern": "^\\d+$"
            }
          ]
        }
      },
      "from": {
        "type": "string",
        "format": "date-time"
      },
      "to": {
        "type": "string",
        "format": "date-time"
      },
      "additional_filters": {
        "type": "object",
        "additionalProperties": {}
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.status` | `string` | Yes | — | — |
| `result.result` | `object` | Yes | — | — |
| `result.result.byDayStats` | `object` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z` | `object` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.profileViews` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.postLikes` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.follows` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.messagesSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.totalMessageStarted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.totalMessageReplies` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.inmailMessagesSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.totalInmailStarted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.totalInmailReplies` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.connectionsSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.connectionsAccepted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.messageReplyRate` | `number` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.inMailReplyRate` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-17T00:00:00Z.connectionAcceptanceRate` | `number` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z` | `object` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.profileViews` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.postLikes` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.follows` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.messagesSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.totalMessageStarted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.totalMessageReplies` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.inmailMessagesSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.totalInmailStarted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.totalInmailReplies` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.connectionsSent` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.connectionsAccepted` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.messageReplyRate` | `number` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.inMailReplyRate` | `integer` | Yes | — | — |
| `result.result.byDayStats.2024-12-18T00:00:00Z.connectionAcceptanceRate` | `number` | Yes | — | — |
| `result.result.overallStats` | `object` | Yes | — | — |
| `result.result.overallStats.profileViews` | `integer` | Yes | — | — |
| `result.result.overallStats.postLikes` | `integer` | Yes | — | — |
| `result.result.overallStats.follows` | `integer` | Yes | — | — |
| `result.result.overallStats.messagesSent` | `integer` | Yes | — | — |
| `result.result.overallStats.totalMessageStarted` | `integer` | Yes | — | — |
| `result.result.overallStats.totalMessageReplies` | `integer` | Yes | — | — |
| `result.result.overallStats.inmailMessagesSent` | `integer` | Yes | — | — |
| `result.result.overallStats.totalInmailStarted` | `integer` | Yes | — | — |
| `result.result.overallStats.totalInmailReplies` | `integer` | Yes | — | — |
| `result.result.overallStats.connectionsSent` | `integer` | Yes | — | — |
| `result.result.overallStats.connectionsAccepted` | `integer` | Yes | — | — |
| `result.result.overallStats.messageReplyRate` | `number` | Yes | — | — |
| `result.result.overallStats.inMailReplyRate` | `integer` | Yes | — | — |
| `result.result.overallStats.connectionAcceptanceRate` | `number` | Yes | — | — |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "properties": {
      "status": {
        "type": "string"
      },
      "result": {
        "type": "object",
        "properties": {
          "byDayStats": {
            "type": "object",
            "properties": {
              "2024-12-17T00:00:00Z": {
                "type": "object",
                "properties": {
                  "profileViews": {
                    "type": "integer"
                  },
                  "postLikes": {
                    "type": "integer"
                  },
                  "follows": {
                    "type": "integer"
                  },
                  "messagesSent": {
                    "type": "integer"
                  },
                  "totalMessageStarted": {
                    "type": "integer"
                  },
                  "totalMessageReplies": {
                    "type": "integer"
                  },
                  "inmailMessagesSent": {
                    "type": "integer"
                  },
                  "totalInmailStarted": {
                    "type": "integer"
                  },
                  "totalInmailReplies": {
                    "type": "integer"
                  },
                  "connectionsSent": {
                    "type": "integer"
                  },
                  "connectionsAccepted": {
                    "type": "integer"
                  },
                  "messageReplyRate": {
                    "type": "number"
                  },
                  "inMailReplyRate": {
                    "type": "integer"
                  },
                  "connectionAcceptanceRate": {
                    "type": "number"
                  }
                },
                "required": [
                  "profileViews",
                  "postLikes",
                  "follows",
                  "messagesSent",
                  "totalMessageStarted",
                  "totalMessageReplies",
                  "inmailMessagesSent",
                  "totalInmailStarted",
                  "totalInmailReplies",
                  "connectionsSent",
                  "connectionsAccepted",
                  "messageReplyRate",
                  "inMailReplyRate",
                  "connectionAcceptanceRate"
                ],
                "additionalProperties": true
              },
              "2024-12-18T00:00:00Z": {
                "type": "object",
                "properties": {
                  "profileViews": {
                    "type": "integer"
                  },
                  "postLikes": {
                    "type": "integer"
                  },
                  "follows": {
                    "type": "integer"
                  },
                  "messagesSent": {
                    "type": "integer"
                  },
                  "totalMessageStarted": {
                    "type": "integer"
                  },
                  "totalMessageReplies": {
                    "type": "integer"
                  },
                  "inmailMessagesSent": {
                    "type": "integer"
                  },
                  "totalInmailStarted": {
                    "type": "integer"
                  },
                  "totalInmailReplies": {
                    "type": "integer"
                  },
                  "connectionsSent": {
                    "type": "integer"
                  },
                  "connectionsAccepted": {
                    "type": "integer"
                  },
                  "messageReplyRate": {
                    "type": "number"
                  },
                  "inMailReplyRate": {
                    "type": "integer"
                  },
                  "connectionAcceptanceRate": {
                    "type": "number"
                  }
                },
                "required": [
                  "profileViews",
                  "postLikes",
                  "follows",
                  "messagesSent",
                  "totalMessageStarted",
                  "totalMessageReplies",
                  "inmailMessagesSent",
                  "totalInmailStarted",
                  "totalInmailReplies",
                  "connectionsSent",
                  "connectionsAccepted",
                  "messageReplyRate",
                  "inMailReplyRate",
                  "connectionAcceptanceRate"
                ],
                "additionalProperties": true
              }
            },
            "required": [
              "2024-12-17T00:00:00Z",
              "2024-12-18T00:00:00Z"
            ],
            "additionalProperties": true
          },
          "overallStats": {
            "type": "object",
            "properties": {
              "profileViews": {
                "type": "integer"
              },
              "postLikes": {
                "type": "integer"
              },
              "follows": {
                "type": "integer"
              },
              "messagesSent": {
                "type": "integer"
              },
              "totalMessageStarted": {
                "type": "integer"
              },
              "totalMessageReplies": {
                "type": "integer"
              },
              "inmailMessagesSent": {
                "type": "integer"
              },
              "totalInmailStarted": {
                "type": "integer"
              },
              "totalInmailReplies": {
                "type": "integer"
              },
              "connectionsSent": {
                "type": "integer"
              },
              "connectionsAccepted": {
                "type": "integer"
              },
              "messageReplyRate": {
                "type": "number"
              },
              "inMailReplyRate": {
                "type": "integer"
              },
              "connectionAcceptanceRate": {
                "type": "number"
              }
            },
            "required": [
              "profileViews",
              "postLikes",
              "follows",
              "messagesSent",
              "totalMessageStarted",
              "totalMessageReplies",
              "inmailMessagesSent",
              "totalInmailStarted",
              "totalInmailReplies",
              "connectionsSent",
              "connectionsAccepted",
              "messageReplyRate",
              "inMailReplyRate",
              "connectionAcceptanceRate"
            ],
            "additionalProperties": true
          }
        },
        "required": [
          "byDayStats",
          "overallStats"
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "status",
      "result"
    ],
    "additionalProperties": true
  }
  ```
</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

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