Create Milestone

POST /sites/{site_id}/milestones

Try it

Create a new milestone

cURL

curl --request POST \
  --url https://api.usefathom.com/v1/sites/{site_id}/milestones \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "milestone_date": "2025-04-06"
}
'

200

{
  "id": "ddc9cdff-ab83-41fa-96c6-dfb276a862e7",
  "object": "milestone",
  "name": "Website redesign",
  "milestone_date": "2023-11-07 05:31:56",
  "created_at": "2023-11-07 05:31:56",
  "updated_at": "2023-11-07 05:31:56"
}

Create a milestone

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

site_id · string · required

The ID of the site you wish to load. This is the same string you use in the tracking code.

Body

application/json

name · string · required

The name of the milestone.

Maximum string length: 255

milestone_date · string · required

The date of the milestone in format YYYY-MM-DD (UTC timezone). The date must be before today's date.

Example:

"2025-04-06"

Response

200 - application/json

id · string · required

Example:

"ddc9cdff-ab83-41fa-96c6-dfb276a862e7"

object · enum<string> · required

Available options: milestone

name · string · required

Example:

"Website redesign"

milestone_date · string · required

Datetime in format YYYY-MM-DD HH:MM:SS (UTC timezone).

Example:

"2023-11-07 05:31:56"

created_at · string · required

Datetime in format YYYY-MM-DD HH:MM:SS (UTC timezone).

Example:

"2023-11-07 05:31:56"

updated_at · string · required

Datetime in format YYYY-MM-DD HH:MM:SS (UTC timezone).

Example:

"2023-11-07 05:31:56"