> ## Documentation Index
> Fetch the complete documentation index at: https://help.scribe-mail.com/llms.txt
> Use this file to discover all available pages before exploring further.

> Pull Scribe signature analytics, conversions, and visitor data. Use when the user wants views, clicks, clickthrough rate, conversion or revenue numbers, a time series, a ranking of signatures, teammates, campaigns, or countries, or a look at identified visitors and where they came from.

# Scribe analytics

# Scribe analytics and visitors

Report on signature performance, conversions, and the visitors signatures bring
in.

## When to use

* Show views and clicks over a date range, with totals and a time series
* Rank a dimension by views or clicks, or compute clickthrough rate
* Report conversions and revenue from recorded events
* Inspect the raw events behind the numbers
* Look up identified visitors and rank which signature or teammate acquired them

## Engagement

* `get_analytics_views` and `get_analytics_clicks` return a time series by
  default. Set `group_by` (signature\_template, marketing\_campaign, teammate,
  anchor, or country) for a ranked breakdown instead.
* There is no clickthrough-rate field. Pull both views and clicks and compute
  clicks divided by views.
* Filter with `start_date`, `end_date`, and any of `signature_template_id`,
  `marketing_campaign_id`, `teammate_id`.

## Conversions and revenue

* `get_analytics_events_summary` returns conversion count and summed value, as a
  time series or a `group_by` breakdown (name, signature\_template,
  marketing\_campaign, teammate, country, currency, or user). Pass a `currency`
  for a clean revenue total.
* `list_analytics_events` returns the raw recorded events for verification or
  export.
* Conversions come from the user's own website through the Scribe JavaScript SDK
  (`@scribemail/js`), recorded with `scribe.track(...)` and keyed by the
  workspace Event Tracking ID. If there are no conversions yet, the SDK is
  probably not installed. You can offer to add it for the user: the snippet and a
  `scribe.track('signup', { value, currency })` call on their signup or checkout
  page, then point them to the Conversion tracking guide in the Scribe docs.

## Visitors

Visitors are the workspace's own identified end-users (from `identify` calls),
not Scribe teammates.

* `list_visitors` lists them, filterable by trait, acquisition channel, and
  first-seen date.
* `get_visitor` returns one visitor with traits, first-touch attribution, and
  lifetime engagement.
* `get_visitor_breakdown` ranks which signature or teammate acquired the most
  visitors.

## Tool reference

All analytics and visitor tools are Read and run without confirmation.

| Tool                           | Access | What it does                                                                      |
| ------------------------------ | ------ | --------------------------------------------------------------------------------- |
| `get_analytics_views`          | Read   | Signature views over a date range, as a time series or a ranked breakdown         |
| `get_analytics_clicks`         | Read   | Signature clicks over a date range, as a time series or a ranked breakdown        |
| `get_analytics_events_summary` | Read   | Aggregated conversion and revenue numbers, as a time series or a ranked breakdown |
| `list_analytics_events`        | Read   | List the raw recorded conversion events behind the analytics                      |
| `list_visitors`                | Read   | List identified visitors with traits and first-touch attribution                  |
| `get_visitor`                  | Read   | Get one identified visitor with traits, attribution, and lifetime engagement      |
| `get_visitor_breakdown`        | Read   | Rank which signature or teammate acquired the most identified visitors            |

## Notes

* Date ranges default to the last two months. `hour` granularity is capped at a
  31-day range.
* Breakdowns, events, and visitor lists are paginated with `page` and `limit`
  (1 to 100).