Fathom Analytics

Fathom Analytics integration (Data). Imported from open-connector.

API key15 toolshttps://api.usefathom.com

GET

fathom_get_account

Retrieve the Fathom account that owns the API key.

/v1/account

GET

fathom_list_sites

List Fathom sites available to the API key.

/v1/sites

3 parameters

Param	Type	Required	Description
limit	integer	optional	The maximum number of objects to return, from 1 to 100.
starting_after	string	optional	A cursor object ID used to page forward chronologically.
ending_before	string	optional	A cursor object ID used to page backward in reverse chronology.

GET

fathom_get_site

Retrieve a single Fathom site by site ID.

/v1/sites/{site_id}

1 parameter

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.

POST

fathom_create_site

Create a Fathom site.

/v1/sites

4 parameters

Param	Type	Required	Description
name	string	required	The website display name, up to 255 characters.
sharing	string	optional	The dashboard sharing configuration for the site.
share_password	string	optional	The password required when sharing is set to private.
timezone	string	optional	The site's reporting timezone as a TZ database name.

POST

fathom_update_site

Update a Fathom site.

/v1/sites/{site_id}

5 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
name	string	optional	The website display name, up to 255 characters.
sharing	string	optional	The dashboard sharing configuration for the site.
share_password	string	optional	The password required when sharing is set to private.
timezone	string	optional	The site's reporting timezone as a TZ database name.

GET

fathom_list_events

List events for a Fathom site.

/v1/sites/{site_id}/events

4 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
limit	integer	optional	The maximum number of objects to return, from 1 to 100.
starting_after	string	optional	A cursor object ID used to page forward chronologically.
ending_before	string	optional	A cursor object ID used to page backward in reverse chronology.

GET

fathom_get_event

Retrieve a single Fathom event by site ID and event ID.

/v1/sites/{site_id}/events/{event_id}

2 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
event_id	string	required	The Fathom event ID, such as signed-up-to-newsletter.

POST

fathom_create_event

Create a Fathom event for a site.

/v1/sites/{site_id}/events

2 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
name	string	required	The event display name, up to 255 characters.

POST

fathom_update_event

Update a Fathom event.

/v1/sites/{site_id}/events/{event_id}

3 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
event_id	string	required	The Fathom event ID, such as signed-up-to-newsletter.
name	string	optional	The event display name, up to 255 characters.

GET

fathom_list_milestones

List milestones for a Fathom site.

/v1/sites/{site_id}/milestones

4 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
limit	integer	optional	The maximum number of objects to return, from 1 to 100.
starting_after	string	optional	A cursor object ID used to page forward chronologically.
ending_before	string	optional	A cursor object ID used to page backward in reverse chronology.

GET

fathom_get_milestone

Retrieve a single Fathom milestone by site ID and milestone ID.

/v1/sites/{site_id}/milestones/{milestone_id}

2 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
milestone_id	string	required	The Fathom milestone ID.

POST

fathom_create_milestone

Create a Fathom milestone for a site.

/v1/sites/{site_id}/milestones

3 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
name	string	required	The milestone display name, up to 255 characters.
milestone_date	string	required	The milestone date in YYYY-MM-DD format. It must be before today.

POST

fathom_update_milestone

Update a Fathom milestone.

/v1/sites/{site_id}/milestones/{milestone_id}

4 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
milestone_id	string	required	The Fathom milestone ID.
name	string	optional	The milestone display name, up to 255 characters.
milestone_date	string	optional	The milestone date in YYYY-MM-DD format. It must be before today.

GET

fathom_run_aggregation

Generate a Fathom analytics aggregation report.

/v1/aggregations

13 parameters

Param	Type	Required	Description
entity	string	required	The Fathom entity to report on.
entity_id	string	optional	The site ID for pageview aggregations.
site_id	string	optional	The Fathom site ID used in the tracking code, such as CDBUGS.
entity_name	string	optional	The event name for event aggregations.
aggregates	array	required	The SUM aggregate fields to include in the report.
date_grouping	string	optional	The date grouping granularity for the report.
field_grouping	array	optional	The Fathom fields to group report rows by.
sort_by	string	optional	The sort expression in field:asc or field:desc form.
timezone	string	optional	Deprecated Fathom timezone override as a TZ database name.
date_from	string	optional	The report start timestamp, such as 2022-04-01 15:31:00.
date_to	string	optional	The report end timestamp, such as 2022-04-30 23:59:59.
limit	integer	optional	The maximum number of aggregation rows to return.
filters	array	optional	Structured Fathom filters to JSON-encode for the filters query parameter.

GET

fathom_get_current_visitors

Fetch the current visitor count and optional detailed breakdown for a Fathom site.

/v1/current_visitors

2 parameters

Param	Type	Required	Description
site_id	string	required	The Fathom site ID used in the tracking code, such as CDBUGS.
detailed	boolean	optional	Whether to include top content and referrer breakdowns.