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

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get form metrics

> Gets aggregate traffic, response, and completion metrics for a Tally form.

`tally.getFormMetrics` gets aggregate traffic, response, and completion metrics for a Tally form.

## Example

```ts automations/tally-get-form-metrics.automation.ts theme={null}
import { automation, onHttpRequest } from "automate.ax"
import { tally } from "automate.ax/tally"

export default automation("Get form metrics", () => {
  onHttpRequest({ scope: "automation" })

  tally.getFormMetrics({
    formId: "form-id",
    period: "30d",
  })
})
```

## Inputs

`formId` and `period` are required. `period` accepts `today`, `yesterday`, `24h`, `7d`, `30d`, `3m`, `6m`, `12m`, or `all`.

Pass `account` to select a named Tally connection.

## Output

Returns visit, submission, respondent, view, start, and completion metrics.