Get form metrics with the Tally API

Returns the totals of a form in the period: visits, total views, starts, submissions, completions, unique respondents, completion rate and the average visit and completion durations.

Identifier
tally_get_form_metrics

The request

POST https://connect.reportei.com/api/tools/tally_get_form_metrics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "form_id": "<form_id>",
    "period": "today"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
form_idstringYesId of the form, from List forms or from the form URL: wA0Bc1 in https://tally.so/r/wA0Bc1.
periodstringYesTime window: today, yesterday, the last 24 hours, 7 or 30 days, 3, 6 or 12 months, or all time.Values: today, yesterday, 24h, 7d, 30d, 3m, 6m, 12m, all

Supported connections

Your customer connects their Tally account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/tally_get_form_metrics. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.