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

# Salesforge: Get Workspaces Workspaceid Sequences Sequenceid Analytics

> Get analytics for a Salesforge sequence over a date range. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get analytics for a Salesforge sequence over a date range.

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

## 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(
  'salesforge_get_workspaces_workspaceid_sequences_sequenceid_analytics',
  {
    "workspaceID": "workspace_123",
    "sequenceID": "sequence_123",
    "from_date": "2026-01-15",
    "to_date": "2026-01-15"
  },
);

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

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute salesforge_get_workspaces_workspaceid_sequences_sequenceid_analytics --input '{
  "workspaceID": "workspace_123",
  "sequenceID": "sequence_123",
  "from_date": "2026-01-15",
  "to_date": "2026-01-15"
}' --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": {
    "days": {},
    "stats": {
      "clicked": 123,
      "clickedPercent": 123,
      "contacted": 123
    }
  }
}
```

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

## Input reference

Get analytics for a sequence.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.workspaceID` | `string` | Yes | — | Workspace ID |
| `payload.sequenceID` | `string` | Yes | — | Sequence ID |
| `payload.from_date` | `string` | Yes | — | From date Format: `date`. |
| `payload.to_date` | `string` | Yes | — | To date Format: `date`. |
| `payload.timezone` | `string` | No | `"UTC"` | Timezone |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get analytics for a sequence.",
    "properties": {
      "workspaceID": {
        "type": "string",
        "description": "Workspace ID"
      },
      "sequenceID": {
        "type": "string",
        "description": "Sequence ID"
      },
      "from_date": {
        "type": "string",
        "description": "From date",
        "format": "date"
      },
      "to_date": {
        "type": "string",
        "description": "To date",
        "format": "date"
      },
      "timezone": {
        "type": "string",
        "description": "Timezone",
        "default": "UTC"
      }
    },
    "required": [
      "workspaceID",
      "sequenceID",
      "from_date",
      "to_date"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.days` | `record` | No | — | key is date in format "2006-01-02" |
| `result.data.stats` | `object` | No | — | — |
| `result.data.stats.clicked` | `integer` | No | — | — |
| `result.data.stats.clickedPercent` | `number` | No | — | — |
| `result.data.stats.contacted` | `integer` | No | — | — |
| `result.data.stats.opened` | `integer` | No | — | — |
| `result.data.stats.openedPercent` | `number` | No | — | — |
| `result.data.stats.replied` | `integer` | No | — | — |
| `result.data.stats.repliedPercent` | `number` | No | — | — |
| `result.data.stats.repliedPositive` | `integer` | No | — | — |
| `result.data.stats.repliedPositivePercent` | `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": {
          "days": {
            "type": "object",
            "description": "key is date in format \"2006-01-02\"",
            "additionalProperties": {
              "type": "object",
              "properties": {
                "replied": {
                  "type": "integer"
                },
                "sent": {
                  "type": "integer"
                },
                "totalClicked": {
                  "type": "integer"
                },
                "totalOpened": {
                  "type": "integer"
                },
                "uniqueClicked": {
                  "type": "integer"
                },
                "uniqueOpened": {
                  "type": "integer"
                }
              },
              "additionalProperties": false
            }
          },
          "stats": {
            "type": "object",
            "properties": {
              "clicked": {
                "type": "integer"
              },
              "clickedPercent": {
                "type": "number"
              },
              "contacted": {
                "type": "integer"
              },
              "opened": {
                "type": "integer"
              },
              "openedPercent": {
                "type": "number"
              },
              "replied": {
                "type": "integer"
              },
              "repliedPercent": {
                "type": "number"
              },
              "repliedPositive": {
                "type": "integer"
              },
              "repliedPositivePercent": {
                "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

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