Fathom Analytics tools
The 11 Fathom Analytics operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List sitesGETLists the sites of the account with id, name, sharing and timezone, oldest first. The id is the code of the tracking script that the other tools ask for. While has_more is true, send the id of the last site as starting_after.
- Get siteGETReturns one site with its name, sharing, timezone and creation date.
- Create sitePOSTCreates a site and returns it with the id to put in the tracking script. Needs a token with the Admin permission.
- Update sitePOSTChanges a site. Only the fields sent change.
- List eventsGETLists every event name the site has tracked, with its currency, sorted by name. Report on an event by its name; its id only works as a page cursor. While has_more is true, send the id of the last event as starting_after.
- Get aggregationGETBuilds a custom report on the pageviews of a site or on one event: totals, or grouped by period and by fields such as pathname, referrer_source or utm_campaign. Numbers come back as text, and there is no pagination: grouped reports return up to 500 rows unless limit says otherwise.
- Get current visitorsGETReturns how many people are on the site right now. With detailed, also the top 150 pages and the top 150 referrers.
- List milestonesGETLists the milestones of the site, the dates marked on its reports, oldest first. While has_more is true, send the id of the last milestone as starting_after.
- Create milestonePOSTMarks a date on the reports of the site, such as a campaign launch.
- Update milestonePOSTChanges a milestone. Send both name and milestone_date, even the one that does not change.
- Delete milestoneDELETEDeletes a milestone for good.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
