Fathom Analytics

App · 17 actions

Read your Fathom Analytics traffic and event reports and live visitor counts, manage sites, event currencies and milestones, and start workflows when a site, event, page or referring site is new, when an event is completed, or when traffic reaches a number you set.

Actions

ActionWhat it does
Create milestoneMark a date on a site's reports, such as a launch or a campaign.
Create siteAdd a site to Fathom.
Delete milestoneDelete a milestone.
Delete siteDelete a site and all its data.
Get accountGet the Fathom account the connection uses: its name and email.
Get current visitorsGet how many people are on a site right now and, if asked, the pages they are on and where they came from (top 150 of each).
Get event reportCount an event's completions and value (in cents) for a period, split by date, page, country, referring site and more, and filtered.
Get milestoneGet one milestone of a site.
Get siteGet one site: its name, sharing and time zone.
Get traffic reportCount a site's visits, pageviews, time on site or bounce rate for a period, split by date, page, country, referring site and more, and filtered.
List eventsList a site's events (the actions it tracks, such as sign-ups), by name.
List milestonesList the milestones (dates marked on reports, such as a launch) of a site.
List sitesList the sites in your Fathom account, oldest first.
Reset event currencyPut an event back on the site's default currency.
Set event currencyChoose the currency an event's values are counted in.
Update milestoneRename a milestone or move it to another day.
Update siteChange a site's name, sharing, time zone or domains.

Create milestone

Mark a date on a site's reports, such as a launch or a campaign.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
NamenametextRequired
What happened, in up to 30 characters.
Datemilestone_datedateRequired
The day to mark.

Outputs

milestoneobject
The milestone
Example output
{
  "milestone": {
    "created_at": "2026-10-30 12:00:00",
    "id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7",
    "milestone_date": "2026-11-02 00:00:00",
    "name": "Redesign launch",
    "object": "milestone",
    "updated_at": "2026-10-30 12:00:00"
  }
}

Create site

Add a site to Fathom. Its site ID is the code its tracking script uses. Needs an API token with Admin access.

Inputs

NamenametextRequired
The site's name in Fathom. It doesn't have to be its address.
Sharingsharingtext
Who can see the site's dashboard without signing in.One of: none (Not shared (default)), private (Shared with a password), public (Public dashboard).
Share passwordshare_passwordtext
The password people type to see the dashboard. Needed when Sharing is 'Shared with a password'.Only when Sharing is Shared with a password.
Time zonetime_zonetext
The time zone the site's reports use. Leave empty to use your account's default.
Domainsdomainstext
Whether the site tracks one domain or several, and if several, whether reports show them together or separately.One of: single (One domain (default)), combined (Several domains, reported together), separate (Several domains, reported separately).

Outputs

siteobject
The site
Example output
{
  "site": {
    "created_at": "2026-07-27 12:01:01",
    "id": "CDBUGS",
    "name": "Acme website",
    "object": "site",
    "sharing": "none",
    "timezone": "America/New_York"
  }
}

Delete milestone

Delete a milestone. This can't be undone.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Milestonemilestone_idtextRequired
The milestone. Pick one, or give its id from an earlier step.

Outputs

deletedtrue/false
True once deleted
milestone_idtext
The milestone deleted
Example output
{
  "deleted": true,
  "milestone_id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7"
}

Delete site

Delete a site and all its data. This can't be undone. Needs an API token with Admin access.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.

Outputs

deletedtrue/false
True once deleted
site_idtext
The site deleted
Example output
{
  "deleted": true,
  "site_id": "CDBUGS"
}

Get account

Get the Fathom account the connection uses: its name and email. Needs an API token with Admin access.

Inputs

None.

Outputs

accountobject
The account
Example output
{
  "account": {
    "email": "jo@example.com",
    "id": 500302232,
    "name": "Jo Bloggs",
    "object": "account"
  }
}

Get current visitors

Get how many people are on a site right now and, if asked, the pages they are on and where they came from (top 150 of each).

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Include pages and referrersdetailedtrue/false
Also list the pages being viewed and the sites people came from.

Outputs

contentlist
The pages being viewed, with how many on each (detailed only)
referrerslist
Where people came from, with how many (detailed only)
totalnumber
People on the site now
Example output
{
  "content": [
    {
      "hostname": "acme.example",
      "pathname": "/pricing",
      "total": 9
    }
  ],
  "referrers": [
    {
      "referrer_hostname": "https://news.example",
      "referrer_pathname": "/story",
      "total": 5
    }
  ],
  "total": 14
}

Get event report

Count an event's completions and value (in cents) for a period, split by date, page, country, referring site and more, and filtered.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Eventevent_nametextRequired
The event's name, exactly as your site tracks it. Pick one, or type it.
NumbersaggregateslistRequired
What to count for the event. Choose one or more.One or more of: conversions (Completions), unique_conversions (Unique completions), value (Value (in cents)).
Fromdate_fromdate and time
Start of the period, read in the site's time zone. Leave empty to start from the site's first data.
Todate_todate and time
End of the period. Leave empty for now.
Split by datedate_groupingtext
One row per hour, day, month or year. Leave empty for one total. By hour needs a period of at most 7 days.One of: hour (By hour (up to 7 days)), day (By day), month (By month), year (By year).
Split byfield_groupinglist
One row per page, country, referring site and so on. Leave empty for no split.One or more of: hostname (Domain), pathname (Page), entry_page (Entry page), exit_page (Exit page), referrer_hostname (Referring site), referrer_pathname (Referring page), referrer_source (Referrer source), ai_source (AI tool), browser, country_code (Country), and 12 more.
Sort bysort_bytext
One of the numbers or splits chosen, or the date when split by date.One of: visits (Visits (people on the site)), uniques (Unique visitors per page), pageviews, avg_duration (Average time on site (seconds)), bounce_rate (Bounce rate), conversions (Completions), unique_conversions (Unique completions), value (Value (in cents)), hostname (Domain), pathname (Page), and 21 more.
Ordersort_ordertext
Which end comes first. Defaults to highest first.One of: desc (Highest or newest first (default)), asc (Lowest or oldest first).
Most rowslimitnumber
At most this many rows, 1 to 1000. Fathom returns up to 500 when splitting unless you set it.From 1 to 1000.
Only the pagepagetext
Only visits to this page path, such as /pricing.
Only from the sitereferrertext
Only visits referred by this site, such as news.ycombinator.com.
Only from the countrycountrytext
Only visitors from this country, as a two-letter code such as US or GB.
Only on the device typedevice_typetext
Only visits on desktops, phones or tablets.One of: Desktop, Mobile, Tablet.
More filtersfilterslist
Further filters, each a property (such as utm_source), an operator (is, is not, is like, is not like, matching, not matching) and a value. Browser, country, city, state, region, device and operating system take only is and is not.

Outputs

countnumber
How many rows
date_fromtext
The start sent to Fathom, in the site's time zone
date_totext
The end sent to Fathom, in the site's time zone
filterslist
The filters applied
rowslist
One row per split (or a single total), with each number asked for
Example output
{
  "count": 1,
  "date_from": "2026-11-01 00:00:00",
  "date_to": "",
  "filters": [],
  "rows": [
    {
      "conversions": 14,
      "unique_conversions": 12,
      "value": 0
    }
  ]
}

Get milestone

Get one milestone of a site.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Milestonemilestone_idtextRequired
The milestone. Pick one, or give its id from an earlier step.

Outputs

milestoneobject
The milestone
Example output
{
  "milestone": {
    "created_at": "2026-10-30 12:00:00",
    "id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7",
    "milestone_date": "2026-11-02 00:00:00",
    "name": "Redesign launch",
    "object": "milestone",
    "updated_at": "2026-10-30 12:00:00"
  }
}

Get site

Get one site: its name, sharing and time zone.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.

Outputs

siteobject
The site
Example output
{
  "site": {
    "created_at": "2026-07-27 12:01:01",
    "id": "CDBUGS",
    "name": "Acme website",
    "object": "site",
    "sharing": "none",
    "timezone": "America/New_York"
  }
}

Get traffic report

Count a site's visits, pageviews, time on site or bounce rate for a period, split by date, page, country, referring site and more, and filtered.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
NumbersaggregateslistRequired
What to count for the site. Choose one or more.One or more of: visits (Visits (people on the site)), uniques (Unique visitors per page), pageviews, avg_duration (Average time on site (seconds)), bounce_rate (Bounce rate).
Fromdate_fromdate and time
Start of the period, read in the site's time zone. Leave empty to start from the site's first data.
Todate_todate and time
End of the period. Leave empty for now.
Split by datedate_groupingtext
One row per hour, day, month or year. Leave empty for one total. By hour needs a period of at most 7 days.One of: hour (By hour (up to 7 days)), day (By day), month (By month), year (By year).
Split byfield_groupinglist
One row per page, country, referring site and so on. Leave empty for no split.One or more of: hostname (Domain), pathname (Page), entry_page (Entry page), exit_page (Exit page), referrer_hostname (Referring site), referrer_pathname (Referring page), referrer_source (Referrer source), ai_source (AI tool), browser, country_code (Country), and 12 more.
Sort bysort_bytext
One of the numbers or splits chosen, or the date when split by date.One of: visits (Visits (people on the site)), uniques (Unique visitors per page), pageviews, avg_duration (Average time on site (seconds)), bounce_rate (Bounce rate), conversions (Completions), unique_conversions (Unique completions), value (Value (in cents)), hostname (Domain), pathname (Page), and 21 more.
Ordersort_ordertext
Which end comes first. Defaults to highest first.One of: desc (Highest or newest first (default)), asc (Lowest or oldest first).
Most rowslimitnumber
At most this many rows, 1 to 1000. Fathom returns up to 500 when splitting unless you set it.From 1 to 1000.
Only the pagepagetext
Only visits to this page path, such as /pricing.
Only from the sitereferrertext
Only visits referred by this site, such as news.ycombinator.com.
Only from the countrycountrytext
Only visitors from this country, as a two-letter code such as US or GB.
Only on the device typedevice_typetext
Only visits on desktops, phones or tablets.One of: Desktop, Mobile, Tablet.
More filtersfilterslist
Further filters, each a property (such as utm_source), an operator (is, is not, is like, is not like, matching, not matching) and a value. Browser, country, city, state, region, device and operating system take only is and is not.

Outputs

countnumber
How many rows
date_fromtext
The start sent to Fathom, in the site's time zone
date_totext
The end sent to Fathom, in the site's time zone
filterslist
The filters applied
rowslist
One row per split (or a single total), with each number asked for
Example output
{
  "count": 1,
  "date_from": "2026-11-01 00:00:00",
  "date_to": "2026-11-05 23:59:59",
  "filters": [],
  "rows": [
    {
      "pageviews": 180,
      "pathname": "/pricing",
      "visits": 120
    }
  ]
}

List events

List a site's events (the actions it tracks, such as sign-ups), by name. Gets one page; to see more, run it again with the next page it gives.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. Fathom's default is 10.From 1 to 100.
Starting afterstarting_aftertext
To get the next page, the 'next_cursor' from the page before. Leave empty to start at the beginning.
Ending beforeending_beforetext
To page backwards (newest first), an id to end before. Leave empty unless paging backwards; not with 'Starting after'.

Outputs

countnumber
How many are on this page
eventslist
The events
has_moretrue/false
Whether more pages follow
next_cursortext
Give this as 'Starting after' (or the cursor you used) for the next page; empty on the last page
Example output
{
  "count": 1,
  "events": [
    {
      "created_at": "2026-08-21 15:24:00",
      "currency": null,
      "id": "IJKLMNOP",
      "name": "Signed up",
      "object": "event"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

List milestones

List the milestones (dates marked on reports, such as a launch) of a site. Gets one page; to see more, run it again with the next page it gives.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Page sizelimitnumber
How many to return, 1 to 100. Fathom's default is 10.From 1 to 100.
Starting afterstarting_aftertext
To get the next page, the 'next_cursor' from the page before. Leave empty to start at the beginning.
Ending beforeending_beforetext
To page backwards (newest first), an id to end before. Leave empty unless paging backwards; not with 'Starting after'.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether more pages follow
milestoneslist
The milestones
next_cursortext
Give this as 'Starting after' (or the cursor you used) for the next page; empty on the last page
Example output
{
  "count": 1,
  "has_more": false,
  "milestones": [
    {
      "created_at": "2026-10-30 12:00:00",
      "id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7",
      "milestone_date": "2026-11-02 00:00:00",
      "name": "Redesign launch",
      "object": "milestone",
      "updated_at": "2026-10-30 12:00:00"
    }
  ],
  "next_cursor": ""
}

List sites

List the sites in your Fathom account, oldest first. Gets one page; to see more, run it again with the next page it gives.

Inputs

Page sizelimitnumber
How many to return, 1 to 100. Fathom's default is 10.From 1 to 100.
Starting afterstarting_aftertext
To get the next page, the 'next_cursor' from the page before. Leave empty to start at the beginning.
Ending beforeending_beforetext
To page backwards (newest first), an id to end before. Leave empty unless paging backwards; not with 'Starting after'.

Outputs

countnumber
How many are on this page
has_moretrue/false
Whether more pages follow
next_cursortext
Give this as 'Starting after' (or the cursor you used) for the next page; empty on the last page
siteslist
The sites
Example output
{
  "count": 1,
  "has_more": false,
  "next_cursor": "",
  "sites": [
    {
      "created_at": "2026-07-27 12:01:01",
      "id": "CDBUGS",
      "name": "Acme website",
      "object": "site",
      "sharing": "none",
      "timezone": "America/New_York"
    }
  ]
}

Reset event currency

Put an event back on the site's default currency. Its data is kept.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Eventevent_nametextRequired
The event's name, exactly as your site tracks it. Pick one, or type it.

Outputs

event_nametext
The event reset
resettrue/false
True once reset
Example output
{
  "event_name": "Signed up",
  "reset": true
}

Set event currency

Choose the currency an event's values are counted in. It can be set before the site first tracks the event.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Eventevent_nametextRequired
The event's name, exactly as your site tracks it. Pick one, or type it.
CurrencycurrencytextRequired
The currency of the values sent with the event.One of: dollar, pound, euro, yuan, peso, shekel, yen, won, hryvnia, franc, and 3 more.

Outputs

eventobject
The event
Example output
{
  "event": {
    "currency": "pound",
    "name": "Signed up"
  }
}

Update milestone

Rename a milestone or move it to another day. A field left empty keeps its value.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Milestonemilestone_idtextRequired
The milestone. Pick one, or give its id from an earlier step.
Namenametext
A new name, up to 30 characters. Leave empty to keep it.
Datemilestone_datedate
A new day. Leave empty to keep it.

Outputs

milestoneobject
The milestone
Example output
{
  "milestone": {
    "created_at": "2026-10-30 12:00:00",
    "id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7",
    "milestone_date": "2026-11-02 00:00:00",
    "name": "Launch",
    "object": "milestone",
    "updated_at": "2026-10-30 12:00:00"
  }
}

Update site

Change a site's name, sharing, time zone or domains. Only the fields given change.

Inputs

Sitesite_idtextRequired
The Fathom site. Pick one, or give its site ID from an earlier step.
Namenametext
A new name for the site. Leave empty to keep it.
Sharingsharingtext
Who can see the site's dashboard without signing in. Leave empty to keep it.One of: none (Not shared (default)), private (Shared with a password), public (Public dashboard).
Share passwordshare_passwordtext
The password people type to see the dashboard. Needed when Sharing is 'Shared with a password'.Only when Sharing is Shared with a password.
Time zonetime_zonetext
The time zone the site's reports use. Leave empty to keep it.
Domainsdomainstext
Whether the site tracks one domain or several, and if several, whether reports show them together or separately. Leave empty to keep it.One of: single (One domain (default)), combined (Several domains, reported together), separate (Several domains, reported separately).

Outputs

changed_fieldslist
The settings that were sent
siteobject
The site as it is now
Example output
{
  "changed_fields": [
    "name"
  ],
  "site": {
    "created_at": "2026-07-27 12:01:01",
    "id": "CDBUGS",
    "name": "Acme",
    "object": "site",
    "sharing": "none",
    "timezone": "America/New_York"
  }
}

On this page