fathom_clear_event_currency

Remove the currency set for an event, so it uses the site's default again. The event and its completion data stay. Needs a manage token for the site. DELETE /sites/{site_id}/events?name=.

destructive

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
event_name*	string	The event's name exactly as tracked (fathom_list_events lists them).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "event_name"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "event_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "The event's name exactly as tracked (fathom_list_events lists them)."
    }
  }
}

fathom_create_milestone

Add a milestone (a dated annotation shown on the site's reports, e.g. a launch or campaign start). Needs a manage token for the site. POST /sites/{site_id}/milestones.

Argument	Type	Description
name*	string	Milestone name (up to 30 characters), e.g. Redesign launch.
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
milestone_date*	string	The milestone's date, YYYY-MM-DD.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "name",
    "milestone_date"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Milestone name (up to 30 characters), e.g. Redesign launch."
    },
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "milestone_date": {
      "type": "string",
      "description": "The milestone's date, YYYY-MM-DD."
    }
  }
}

fathom_create_site

Create a new site in the Fathom account (returns its id, used in the tracking code). Needs an Admin token. Sharing private needs share_password; multi_domain true needs multi_domain_option. POST /sites.

Argument	Type	Description
name*	string	Site name (up to 255 characters; need not match the URL).
sharing	string	Dashboard sharing: none (default), private (password) or public.
timezone	string	Reporting timezone as a TZ database name, e.g. America/New_York, Europe/London, UTC.
multi_domain	boolean	true = the site may track multiple domains.
share_password	string	Required when sharing is private: the password for the shared dashboard.
multi_domain_option	string	Required when multi_domain is true: report domains combined or separate.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Site name (up to 255 characters; need not match the URL)."
    },
    "sharing": {
      "enum": [
        "none",
        "private",
        "public"
      ],
      "type": "string",
      "description": "Dashboard sharing: none (default), private (password) or public."
    },
    "timezone": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9_+-]*(\\/[A-Za-z0-9_+-]+){0,2}$",
      "maxLength": 64,
      "description": "Reporting timezone as a TZ database name, e.g. America/New_York, Europe/London, UTC."
    },
    "multi_domain": {
      "type": "boolean",
      "description": "true = the site may track multiple domains."
    },
    "share_password": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Required when sharing is private: the password for the shared dashboard."
    },
    "multi_domain_option": {
      "enum": [
        "combined",
        "separate"
      ],
      "type": "string",
      "description": "Required when multi_domain is true: report domains combined or separate."
    }
  }
}

fathom_delete_milestone

Permanently delete a milestone (only the annotation; traffic data is not touched). Cannot be undone. Needs a manage token for the site. DELETE /sites/{site_id}/milestones/{milestone_id}.

destructive

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
milestone_id*	string	The milestone id (a UUID, from fathom_list_milestones).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "milestone_id"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "milestone_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The milestone id (a UUID, from fathom_list_milestones)."
    }
  }
}

fathom_get_account

The Fathom account that owns the API token: id, name and email. Needs an Admin token (the * scope). GET /account.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

fathom_get_aggregation

Fathom's custom report (the dashboard's numbers): aggregate pageviews or one event over a date range, optionally grouped by date and/or fields and filtered. Pageviews: aggregates visits (unique site visits), uniques (unique page visits), pageviews, avg_duration (seconds), bounce_rate. Events (entity event + event_name): conversions, unique_conversions, value (in cents). Examples: top pages = field_grouping [pathname], sort_by pageviews:desc; traffic sources = [referrer_source] or [referrer_hostname]; AI referrals = [ai_source]; daily trend = date_grouping day. All numbers come back as strings. Dates are in the site's timezone; hour grouping only for ranges up to 7 days. Grouped reports return at most 500 rows unless limit is set (max 1000, no paging), so narrow with filters or dates. Data before March 2021 cannot be grouped/filtered. GET /aggregations.

read-only

Argument	Type	Description
limit	integer	Row cap, 1-1000 (default 500 when grouping by fields).
entity*	string	pageview = site traffic; event = one event's conversions (needs event_name).
date_to	string	End, YYYY-MM-DD (end of day) or "YYYY-MM-DD HH:MM:SS", in the site's timezone. Default: now.
filters	array	Filters, all applied (AND). Example: [{"property":"country_code","operator":"is","value":"GB"}].
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.

fathom_get_current_visitors

Live visitors on a site right now: the total, and with detailed true the top 150 pages (hostname, pathname, total) and top 150 referrers. GET /current_visitors.

read-only

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
detailed	boolean	true = also the top pages and referrers (default false: only the count).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "detailed": {
      "type": "boolean",
      "description": "true = also the top pages and referrers (default false: only the count)."
    }
  }
}

fathom_get_milestone

One milestone: id, name, milestone_date, created_at, updated_at. GET /sites/{site_id}/milestones/{milestone_id}.

read-only

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
milestone_id*	string	The milestone id (a UUID, from fathom_list_milestones).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "milestone_id"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "milestone_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The milestone id (a UUID, from fathom_list_milestones)."
    }
  }
}

fathom_get_site

One site: id, name, sharing (none/private/public), timezone and created_at. GET /sites/{site_id}.

read-only

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    }
  }
}

fathom_get_token

The connected API token's name, permissions (abilities: "*" = Admin, "all-sites-readonly", or per-site read:<id> / manage:<id>) and timestamps. The secret value is never returned. Good first call to know which tools will work. GET /token.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

fathom_list_events

List a site's events (conversions/goals): every event name the site has tracked plus events with a currency set, sorted by name. Identify events by name (use it as event_name in fathom_get_aggregation); the id is only a paging cursor. Paged: pass next.starting_after. GET /sites/{site_id}/events.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 10).
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
ending_before	string	Page backward from this object id (newest first). Not together with starting_after.
starting_after	string	Page forward: pass next.starting_after from the previous reply (an object id).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 10)."
    },
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "ending_before": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page backward from this object id (newest first). Not together with starting_after."
    },
    "starting_after": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page forward: pass next.starting_after from the previous reply (an object id)."
    }
  }
}

fathom_list_milestones

List a site's milestones (dated annotations on reports, such as a redesign launch or a campaign start), oldest first. Paged: pass next.starting_after. GET /sites/{site_id}/milestones.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 10).
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
ending_before	string	Page backward from this object id (newest first). Not together with starting_after.
starting_after	string	Page forward: pass next.starting_after from the previous reply (an object id).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id"
  ],
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 10)."
    },
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "ending_before": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page backward from this object id (newest first). Not together with starting_after."
    },
    "starting_after": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page forward: pass next.starting_after from the previous reply (an object id)."
    }
  }
}

fathom_list_sites

List the sites the token can read (id, name, sharing, timezone, created_at), oldest first. The site id is what every report tool takes. Needs an Admin or all-sites read-only token; a token scoped to a single site cannot list sites, so use fathom_get_site with that site id instead. Paged: pass next.starting_after. GET /sites.

read-only

Argument	Type	Description
limit	integer	Items per page, 1-100 (default 10).
ending_before	string	Page backward from this object id (newest first). Not together with starting_after.
starting_after	string	Page forward: pass next.starting_after from the previous reply (an object id).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "limit": {
      "type": "integer",
      "maximum": 100,
      "minimum": 1,
      "description": "Items per page, 1-100 (default 10)."
    },
    "ending_before": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page backward from this object id (newest first). Not together with starting_after."
    },
    "starting_after": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "Page forward: pass next.starting_after from the previous reply (an object id)."
    }
  }
}

fathom_set_event_currency

Set the currency of an event's value by event name (works before the event is first tracked). Needs a manage token for the site. POST /sites/{site_id}/events/currency.

destructive

Argument	Type	Description
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
currency*	string	dollar, pound, euro, yuan, peso, shekel, yen, won, hryvnia, franc, rupee, integer (a plain number) or none.
event_name*	string	The event's name exactly as tracked (up to 255 characters; fathom_list_events lists them).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "event_name",
    "currency"
  ],
  "properties": {
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "currency": {
      "enum": [
        "dollar",
        "pound",
        "euro",
        "yuan",
        "peso",
        "shekel",
        "yen",
        "won",
        "hryvnia",
        "franc",
        "rupee",
        "integer",
        "none"
      ],
      "type": "string",
      "description": "dollar, pound, euro, yuan, peso, shekel, yen, won, hryvnia, franc, rupee, integer (a plain number) or none."
    },
    "event_name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "The event's name exactly as tracked (up to 255 characters; fathom_list_events lists them)."
    }
  }
}

fathom_update_milestone

Rename or re-date a milestone (both name and milestone_date are required). Needs a manage token for the site. POST /sites/{site_id}/milestones/{milestone_id}.

destructive

Argument	Type	Description
name*	string	Milestone name (up to 30 characters), e.g. Redesign launch.
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
milestone_id*	string	The milestone id (a UUID, from fathom_list_milestones).
milestone_date*	string	The milestone's date, YYYY-MM-DD.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id",
    "milestone_id",
    "name",
    "milestone_date"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 30,
      "minLength": 1,
      "description": "Milestone name (up to 30 characters), e.g. Redesign launch."
    },
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "milestone_id": {
      "type": "string",
      "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$",
      "description": "The milestone id (a UUID, from fathom_list_milestones)."
    },
    "milestone_date": {
      "type": "string",
      "description": "The milestone's date, YYYY-MM-DD."
    }
  }
}

fathom_update_site

Change a site's name, sharing, timezone or multi-domain setting (send only what changes). Changing the timezone changes how reports are bucketed. Needs a manage token for the site. POST /sites/{site_id}.

destructive

Argument	Type	Description
name	string	New site name (up to 255 characters).
sharing	string	Dashboard sharing: none, private (needs share_password) or public.
site_id*	string	The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them.
timezone	string	Reporting timezone as a TZ database name, e.g. America/New_York, Europe/London, UTC.
multi_domain	boolean	true = the site may track multiple domains.
share_password	string	Required when setting sharing to private.
multi_domain_option	string	Required when multi_domain is true: combined or separate.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "site_id"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "New site name (up to 255 characters)."
    },
    "sharing": {
      "enum": [
        "none",
        "private",
        "public"
      ],
      "type": "string",
      "description": "Dashboard sharing: none, private (needs share_password) or public."
    },
    "site_id": {
      "type": "string",
      "pattern": "^[A-Za-z0-9_-]{1,64}$",
      "description": "The site id, the same string as in the tracking code (e.g. CDBUGS). fathom_list_sites lists them."
    },
    "timezone": {
      "type": "string",
      "pattern": "^[A-Za-z][A-Za-z0-9_+-]*(\\/[A-Za-z0-9_+-]+){0,2}$",
      "maxLength": 64,
      "description": "Reporting timezone as a TZ database name, e.g. America/New_York, Europe/London, UTC."
    },
    "multi_domain": {
      "type": "boolean",
      "description": "true = the site may track multiple domains."
    },
    "share_password": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "Required when setting sharing to private."
    },
    "multi_domain_option": {
      "enum": [
        "combined",
        "separate"
      ],
      "type": "string",
      "description": "Required when multi_domain is true: combined or separate."
    }
  }
}

Fathom Analytics MCP by usefulapi

Try it

fathom_clear_event_currency

Fathom Analytics MCP by usefulapi

Try it

fathom_clear_event_currency

Tools (16)