Report engagement rates

Outcome

Report reply, positive, opt-out and bounce rates for the current workspace, grouped by campaign, sequence, step, seat (mailbox) or subject template, for contacts first touched between from and to (UTC dates, inclusive, at most 366 days; 422 invalid_period otherwise), optionally for one campaign. First-touch attribution: each contact is counted once, under the group of its earliest sent message in the period. replied = (reply OR positive OR opted out) AND NOT bounced. Rates are count / contacted to 4 decimal places. Test campaigns (isTest) are excluded. Reads derived facts; run analytics.rebuild if they look stale. Read-only.

Before you start

• Verify the intended environment, signed-in credential, authorized organization and the action permission workspace:read.
• Discover and select an authorized canonical Engage workspace. Pass resourceType=workspace and resourceId separately from action input.

Discover the target

topolo whoami --json
topolo actions get app_topolo_engage.analytics.report --json
topolo workspaces list topolo-engage --json

Set ENGAGE_WORKSPACE_ID to the identifier of the selected authorized workspace.

Input contract

Validate, plan and execute

Build payload.json from the current schema and discovered identifiers. The action description above defines its behavior, limits, side effects and declared errors.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions validate app_topolo_engage.analytics.report --data @payload.json --json
topolo actions plan app_topolo_engage.analytics.report --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

Execute the unchanged validated read.

: "${ENGAGE_WORKSPACE_ID:?Set ENGAGE_WORKSPACE_ID to your selected workspace identifier}"
topolo actions call app_topolo_engage.analytics.report --resource-type workspace --resource-id "$ENGAGE_WORKSPACE_ID" --data @payload.json --json

For MCP, use topolo_get_action, topolo_validate_action, topolo_plan_action and topolo_call_action. Pass resource context separately where required; confirm:true is required for mutations.

Captured successful requests and responses

Captured HTTP 200 · engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded

Action input

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_cmp_1",
      "label": "Q4",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_cmp_2",
      "label": "Q4",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "sequence",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "sequence",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_seq_1",
      "label": "Main",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_seq_2",
      "label": "Main",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > refuses a reversed, too long or impossible period

Action input

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [],
  "totals": {
    "contacted": 0,
    "replied": 0,
    "positive": 0,
    "opted_out": 0,
    "bounced": 0,
    "replyRate": 0,
    "positiveRate": 0,
    "optOutRate": 0,
    "bounceRate": 0
  }
}

Source test: engagement analytics > refuses a reversed, too long or impossible period. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded

Action input

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "campaignId": "eng_cmp_2"
}

Actual local response

{
  "groupBy": "campaign",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_cmp_2",
      "label": "Q4",
      "contacted": 3,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 3,
    "replied": 0,
    "positive": 0,
    "opted_out": 0,
    "bounced": 0,
    "replyRate": 0,
    "positiveRate": 0,
    "optOutRate": 0,
    "bounceRate": 0
  }
}

Source test: engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded

Action input

{
  "groupBy": "campaign",
  "from": "2026-10-07",
  "to": "2026-10-07"
}

Actual local response

{
  "groupBy": "campaign",
  "from": "2026-10-07",
  "to": "2026-10-07",
  "rows": [
    {
      "key": "eng_cmp_2",
      "label": "Q4",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 2,
    "replied": 0,
    "positive": 0,
    "opted_out": 0,
    "bounced": 0,
    "replyRate": 0,
    "positiveRate": 0,
    "optOutRate": 0,
    "bounceRate": 0
  }
}

Source test: engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded

Action input

{
  "groupBy": "campaign",
  "from": "2026-11-01",
  "to": "2026-11-30"
}

Actual local response

{
  "groupBy": "campaign",
  "from": "2026-11-01",
  "to": "2026-11-30",
  "rows": [],
  "totals": {
    "contacted": 0,
    "replied": 0,
    "positive": 0,
    "opted_out": 0,
    "bounced": 0,
    "replyRate": 0,
    "positiveRate": 0,
    "optOutRate": 0,
    "bounceRate": 0
  }
}

Source test: engagement analytics > reports first-touch rates by campaign: each contact once, bounced never replied, test campaigns excluded. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "step",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "step",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_stp_1",
      "label": "Main #1",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_stp_3",
      "label": "Main #1",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "seat",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "seat",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_seat_1",
      "label": "Ash",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_seat_2",
      "label": "Bea",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "subject",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "subject",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "416cb9646480512ac65481f3c91a9bc622bbce6c1a3163dd2b7dbe69999ee8d6",
      "label": "Quick question, {{first_name}}",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "15b4ba90465b7d02e99be7ba3289fc6b39269e002b9315b93cadd3955b310387",
      "label": "Hello {{first_name}}",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "step",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "step",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_stp_1",
      "label": "eng_seq_1 #1",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_stp_3",
      "label": "eng_seq_2 #1",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 200 · engagement analytics > groups by sequence, step, seat and subject template

Action input

{
  "groupBy": "seat",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "groupBy": "seat",
  "from": "2026-10-01",
  "to": "2026-10-31",
  "rows": [
    {
      "key": "eng_seat_1",
      "label": "eng_seat_1",
      "contacted": 4,
      "replied": 2,
      "positive": 1,
      "opted_out": 1,
      "bounced": 1,
      "replyRate": 0.5,
      "positiveRate": 0.25,
      "optOutRate": 0.25,
      "bounceRate": 0.25
    },
    {
      "key": "eng_seat_2",
      "label": "eng_seat_2",
      "contacted": 2,
      "replied": 0,
      "positive": 0,
      "opted_out": 0,
      "bounced": 0,
      "replyRate": 0,
      "positiveRate": 0,
      "optOutRate": 0,
      "bounceRate": 0
    }
  ],
  "totals": {
    "contacted": 6,
    "replied": 2,
    "positive": 1,
    "opted_out": 1,
    "bounced": 1,
    "replyRate": 0.3333,
    "positiveRate": 0.1667,
    "optOutRate": 0.1667,
    "bounceRate": 0.1667
  }
}

Source test: engagement analytics > groups by sequence, step, seat and subject template. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Effects and response meaning

• Report reply, positive, opt-out and bounce rates for the current workspace, grouped by campaign, sequence, step, seat (mailbox) or subject template, for contacts first touched between from and to (UTC dates, inclusive, at most 366 days; 422 invalid_period otherwise), optionally for one campaign. First-touch attribution: each contact is counted once, under the group of its earliest sent message in the period. replied = (reply OR positive OR opted out) AND NOT bounced. Rates are count / contacted to 4 decimal places. Test campaigns (isTest) are excluded. Reads derived facts; run analytics.rebuild if they look stale. Read-only.

Verify the outcome

• Check the response against the declared output schema and the requested operation. For mutations, use the action-specific read described in the action description before any dependent operation.

Recover

For an uncertain result, inspect current retained state with a read action before retrying. Do not replay a mutation unless its contract explicitly guarantees idempotency.

Refused requests

Captured HTTP 422 · engagement analytics > refuses a reversed, too long or impossible period

Action input

{
  "groupBy": "campaign",
  "from": "2026-10-02",
  "to": "2026-10-01"
}

Actual local response

{
  "error": {
    "code": "invalid_period",
    "message": "Use a period whose start is on or before its end, at most 366 days long."
  }
}

Source test: engagement analytics > refuses a reversed, too long or impossible period. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · engagement analytics > refuses a reversed, too long or impossible period

Refused input; do not execute

{
  "groupBy": "channel",
  "from": "2026-10-01",
  "to": "2026-10-31"
}

Actual local response

{
  "error": {
    "code": "invalid_action_input",
    "message": "Input for analytics.report is invalid.",
    "details": [
      {
        "code": "invalid_value",
        "values": [
          "campaign",
          "sequence",
          "step",
          "seat",
          "subject"
        ],
        "path": [
          "groupBy"
        ],
        "message": "Invalid option: expected one of \"campaign\"|\"sequence\"|\"step\"|\"seat\"|\"subject\""
      }
    ]
  }
}

Source test: engagement analytics > refuses a reversed, too long or impossible period. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · engagement analytics > refuses a reversed, too long or impossible period

Action input

{
  "groupBy": "campaign",
  "from": "2025-01-01",
  "to": "2026-10-01"
}

Actual local response

{
  "error": {
    "code": "invalid_period",
    "message": "Use a period whose start is on or before its end, at most 366 days long."
  }
}

Source test: engagement analytics > refuses a reversed, too long or impossible period. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Captured HTTP 422 · engagement analytics > refuses a reversed, too long or impossible period

Action input

{
  "groupBy": "campaign",
  "from": "2026-13-45",
  "to": "2026-10-01"
}

Actual local response

{
  "error": {
    "code": "invalid_period",
    "message": "Use a period whose start is on or before its end, at most 366 days long."
  }
}

Source test: engagement analytics > refuses a reversed, too long or impossible period. Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

Error recovery

• HTTP 422 invalid_period: Read the refusal details and current action contract, correct the stated cause, then validate and plan again. Do not retry unchanged or infer success.
• HTTP 422 invalid_action_input: Correct the request against the current action input schema, then validate it again before planning.

Related actions

• Rebuild engagement analytics

Evidence and limits

• /api/analytics/report

• Actual route handlers with SQLite repositories; synthetic identity/workspace grants and provider ports.

• Widget/bootstrap use actual app handler but mocked worker runtime and app identity.

• No gateway execution, live permissions, external delivery or deployed proof.

These are local route captures with synthetic identity and simulated dependencies. They do not prove live authorization, gateway execution, production state, or external delivery.