Get template report

Report every send rendered from one template id, across journeys and broadcasts: headline conversions and revenue, clicks, delivery engagement and opens with a privacy caveat. An id nothing was sent from reports zeros. Covers messages sent in the last days (default 30, max 365). Conversions are goal lifecycle events (attribution_settings, default purchase) credited last-touch: the latest send (or click, basis click) to that contact within windowDays before the event gets it and its revenue (properties amountMinor + currency, summed per currency). Engagement is unique per send. Opens only count with open tracking on and are approximate (opens.caveat); judge on conversions and revenue.

Outcome

Before you start

Verify identity and pin the intended organization and environment before discovering the action.
Discover a granted Nurture workspace. The application permission is workspace:read; required workspace access is read. A permission alone does not supply a workspace grant.
Organization and workspace come from verified context. Select resourceType/resourceId separately from action input; body fields cannot grant a different organization or workspace. The first authorized product action can initialize an identity-only workspace mirror.

Discover the target

topolo whoami --json
topolo actions get app_topolo_nurture.reports.template --detail --json
topolo resources topolo-nurture --json
topolo workspaces list topolo-nurture --json
topolo actions get app_topolo_nurture.templates.list --detail --json

id: template id from its corresponding workspace list.

Request

GET /api/reports/templates/{id}

Save action input as payload.json. The reviewed plan separates path identifiers, query fields and HTTP body. Set NURTURE_WORKSPACE_ID from granted resource discovery; it is separate from action input.

Inspect and test this action in the signed action console. A test response still requires the verification below.

Input fields

Field	Required	Type	Constraints
`id`	Required	string	template id from its corresponding workspace list. {"minLength":1,"maxLength":120}
`days`	Optional	integer	{"minimum":1,"maximum":365}

Exact input schema:

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "days": {
      "type": "integer",
      "minimum": 1,
      "maximum": 365
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false
}

Effects

Reads one template's sends, engagement and attributed conversions without changing state.

Interpret the response

The returned identifier path is $.report.subject.id for template. Empty lists do not discover a target.

Confirm $.report.subject and $.report.period are what you asked for; when $.report.truncated is true narrow days.

Exact success schema:

{
  "type": "object",
  "required": [
    "report"
  ],
  "properties": {
    "report": {
      "type": "object",
      "required": [
        "subject",
        "period",
        "attribution",
        "headline",
        "engagement",
        "opens",
        "byTemplate",
        "truncated"
      ],
      "properties": {
        "subject": {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "overview",
                "journey",
                "broadcast",
                "template"
              ]
            },
            "id": {
              "type": [
                "string",
                "null"
              ]
            }
          }
        },
        "period": {
          "type": "object",
          "properties": {
            "from": {
              "type": "string"
            },
            "to": {
              "type": "string"
            },
            "days": {
              "type": "integer"
            }
          }
        },
        "attribution": {
          "type": "object",
          "properties": {
            "model": {
              "type": "string",
              "enum": [
                "last_touch"
              ]
            },
            "basis": {
              "type": "string",
              "enum": [
                "send",
                "click"
              ]
            },
            "windowDays": {
              "type": "integer"
            },
            "goalEventTypes": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        },
        "headline": {
          "type": "object",
          "required": [
            "conversions",
            "revenue",
            "conversionRate"
          ],
          "properties": {
            "conversions": {
              "type": "integer"
            },
            "revenue": {
              "type": "array",
              "items": {
                "type": "object",
                "required": [
                  "currency",
                  "amountMinor"
                ],
                "properties": {
                  "currency": {
                    "type": "string"
                  },
                  "amountMinor": {
                    "type": "integer"
                  }
                }
              }
            },
            "conversionRate": {
              "type": [
                "number",
                "null"
              ]
            }
          }
        },
        "engagement": {
          "type": "object",
          "properties": {
            "sent": {
              "type": "integer"
            },
            "delivered": {
              "type": "integer"
            },
            "clicked": {
              "type": "integer"
            },
            "clickRate": {
              "type": [
                "number",
                "null"
              ]
            },
            "bounced": {
              "type": "integer"
            },
            "complained": {
              "type": "integer"
            },
            "unsubscribed": {
              "type": "integer"
            }
          }
        },
        "opens": {
          "type": "object",
          "required": [
            "tracking",
            "count",
            "rate",
            "caveat"
          ],
          "properties": {
            "tracking": {
              "type": "boolean"
            },
            "count": {
              "type": "integer"
            },
            "rate": {
              "type": [
                "number",
                "null"
              ]
            },
            "caveat": {
              "type": "string"
            }
          }
        },
        "clickTracking": {
          "type": "boolean"
        },
        "bySource": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "metrics"
            ],
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "journey",
                  "broadcast"
                ]
              },
              "id": {
                "type": "string"
              },
              "metrics": {
                "type": "object",
                "properties": {
                  "sent": {
                    "type": "integer"
                  },
                  "delivered": {
                    "type": "integer"
                  },
                  "opened": {
                    "type": "integer"
                  },
                  "clicked": {
                    "type": "integer"
                  },
                  "bounced": {
                    "type": "integer"
                  },
                  "complained": {
                    "type": "integer"
                  },
                  "unsubscribed": {
                    "type": "integer"
                  },
                  "conversions": {
                    "type": "integer"
                  },
                  "revenue": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "currency",
                        "amountMinor"
                      ],
                      "properties": {
                        "currency": {
                          "type": "string"
                        },
                        "amountMinor": {
                          "type": "integer"
                        }
                      }
                    }
                  },
                  "clickRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "openRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "conversionRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  }
                }
              }
            }
          }
        },
        "byTemplate": {
          "type": "array",
          "items": {
            "type": "object",
            "required": [
              "id",
              "metrics"
            ],
            "properties": {
              "kind": {
                "type": "string",
                "enum": [
                  "journey",
                  "broadcast"
                ]
              },
              "id": {
                "type": "string"
              },
              "metrics": {
                "type": "object",
                "properties": {
                  "sent": {
                    "type": "integer"
                  },
                  "delivered": {
                    "type": "integer"
                  },
                  "opened": {
                    "type": "integer"
                  },
                  "clicked": {
                    "type": "integer"
                  },
                  "bounced": {
                    "type": "integer"
                  },
                  "complained": {
                    "type": "integer"
                  },
                  "unsubscribed": {
                    "type": "integer"
                  },
                  "conversions": {
                    "type": "integer"
                  },
                  "revenue": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "currency",
                        "amountMinor"
                      ],
                      "properties": {
                        "currency": {
                          "type": "string"
                        },
                        "amountMinor": {
                          "type": "integer"
                        }
                      }
                    }
                  },
                  "clickRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "openRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  },
                  "conversionRate": {
                    "type": [
                      "number",
                      "null"
                    ]
                  }
                }
              }
            }
          }
        },
        "truncated": {
          "type": "boolean"
        }
      }
    }
  }
}

Worked examples

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Replace synthetic identifiers using credential-scoped discovery. A local success is not evidence of a deployed effect, configured provider or delivered message.

Successful request

Actual dispatcher and migration-created SQLite; verified identity/workspace and external CRM, Engage, Notify, Consent, Nexus, Brand, Generator, Voice and delivery dependencies are simulated. No live authorization, paid generation or external delivery is established.

Input · payload.json:

{
  "id": "tpl_5232108589f14080a2397f82f225d496"
}

CLI:

topolo actions validate app_topolo_nurture.reports.template --data @payload.json --json
topolo actions plan app_topolo_nurture.reports.template --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.reports.template --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.reports.template",
    "input": {
      "id": "tpl_5232108589f14080a2397f82f225d496"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "report": {
    "subject": {
      "kind": "template",
      "id": "tpl_5232108589f14080a2397f82f225d496"
    },
    "period": {
      "from": "2026-09-12T09:00:00.000Z",
      "to": "2026-10-12T09:00:00.000Z",
      "days": 30
    },
    "attribution": {
      "model": "last_touch",
      "basis": "send",
      "windowDays": 7,
      "goalEventTypes": [
        "purchase"
      ]
    },
    "headline": {
      "conversions": 1,
      "revenue": [
        {
          "currency": "GBP",
          "amountMinor": 1999
        }
      ],
      "conversionRate": 0.3333
    },
    "engagement": {
      "sent": 3,
      "delivered": 1,
      "clicked": 1,
      "clickRate": 0.3333,
      "bounced": 0,
      "complained": 0,
      "unsubscribed": 0
    },
    "opens": {
      "tracking": false,
      "count": 0,
      "rate": 0,
      "caveat": "Opens are approximate and privacy-sensitive: mail clients that preload images (such as Apple Mail Privacy Protection) record opens nobody made, and clients that block images hide real ones. Treat opens as a rough signal; judge results on clicks, conversions and revenue."
    },
    "clickTracking": true,
    "byTemplate": [
      {
        "id": "tpl_5232108589f14080a2397f82f225d496",
        "metrics": {
          "sent": 3,
          "delivered": 1,
          "opened": 0,
          "clicked": 1,
          "bounced": 0,
          "complained": 0,
          "unsubscribed": 0,
          "conversions": 1,
          "revenue": [
            {
              "currency": "GBP",
              "amountMinor": 1999
            }
          ],
          "clickRate": 0.3333,
          "openRate": 0,
          "conversionRate": 0.3333
        }
      }
    ],
    "truncated": false
  }
}

HTTP 200. Confirm $.report.subject and $.report.period are what you asked for; when $.report.truncated is true narrow days.

Another supported request

Input · payload.json:

{
  "id": "unknown"
}

CLI:

topolo actions validate app_topolo_nurture.reports.template --data @payload.json --json
topolo actions plan app_topolo_nurture.reports.template --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_nurture.reports.template --resource-type workspace --resource-id "$NURTURE_WORKSPACE_ID" --data @payload.json --json

MCP tool and arguments:

{
  "tool": "topolo_read_action",
  "arguments": {
    "actionId": "app_topolo_nurture.reports.template",
    "input": {
      "id": "unknown"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by resource discovery>"
  }
}

Captured local response · HTTP 200:

{
  "report": {
    "subject": {
      "kind": "template",
      "id": "unknown"
    },
    "period": {
      "from": "2026-09-12T09:00:00.000Z",
      "to": "2026-10-12T09:00:00.000Z",
      "days": 30
    },
    "attribution": {
      "model": "last_touch",
      "basis": "send",
      "windowDays": 7,
      "goalEventTypes": [
        "purchase"
      ]
    },
    "headline": {
      "conversions": 0,
      "revenue": [],
      "conversionRate": null
    },
    "engagement": {
      "sent": 0,
      "delivered": 0,
      "clicked": 0,
      "clickRate": null,
      "bounced": 0,
      "complained": 0,
      "unsubscribed": 0
    },
    "opens": {
      "tracking": false,
      "count": 0,
      "rate": null,
      "caveat": "Opens are approximate and privacy-sensitive: mail clients that preload images (such as Apple Mail Privacy Protection) record opens nobody made, and clients that block images hide real ones. Treat opens as a rough signal; judge results on clicks, conversions and revenue."
    },
    "clickTracking": true,
    "byTemplate": [],
    "truncated": false
  }
}

HTTP 200. Confirm $.report.subject and $.report.period are what you asked for; when $.report.truncated is true narrow days.

Verify the result

Confirm $.report.subject and $.report.period are what you asked for; when $.report.truncated is true narrow days.

Errors and recovery

organization_required (HTTP 403): Select an organization available to the verified caller before choosing a Nurture workspace.
permission_denied (HTTP 403): Grant the credential the required Nurture workspace permission.
workspace_required (HTTP 409): Create a Nurture workspace, or pass the workspace resource context.
invalid_input (HTTP 422): Correct the fields named in error.details using inputSchema, then retry.

Auth or gateway failures may precede this handler. Preserve the exact response shape, error string/code, request id and credential context; no synthetic fixture establishes live credential access.

Recovery boundary

This action does not change service state.

Get attribution settings: Read how Nurture credits conversions: goalEventTypes (lifecycle event types that count as a conversion, default ["purchase"]), windowDays (default 7) and basis (send: the window opens at each send; click: only clicked sends compete). The model is always last_touch.
Get tracking settings: Read whether Nurture tracks clicks (on by default: external https links become signed redirects that only lead to the URL recorded when the message was rendered) and opens (off by default: a 1x1 pixel; approximate and privacy-sensitive, see opensCaveat).

Evidence

Actual dispatcher and migration-created SQLite or Worker handlers; identity/workspace and external service dependencies are simulated. Fixture identifiers and timestamps are synthetic. These responses establish no live authorization, paid generation, credential provisioning or message delivery. Test scenario and capture digests are retained with each fixture.

Get template report

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence