Create milestone with the Fathom Analytics API
Marks a date on the reports of the site, such as a campaign launch.
- Identifier
- fathom_create_milestone
The request
POST https://connect.reportei.com/api/tools/fathom_create_milestone/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"site_id": "<site_id>",
"name": "<name>",
"milestone_date": "<milestone_date>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| site_id | string | Yes | Id of the site, from List sites. It is the code of the tracking script, for example CDBUGS. |
| name | string | Yes | Name of the milestone, up to 30 characters. |
| milestone_date | string | Yes | Date of the milestone as YYYY-MM-DD. |
Supported connections
Your customer connects their Fathom Analytics account once, with one of the modes below. The same connection serves every tool of the toolkit.
API key
Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/fathom_create_milestone. It becomes your agent's tool definition with no conversion.
Other Fathom Analytics tools
- 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.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
