Milestones

Create milestone

Changed on

Create a milestone. Returns HTTP 201 Created on success.

Permissions: Requires write access to the site (manage:{site_id}).

Returns: A milestone object.

post/sites/{site_id}/milestones

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/sites/{site_id}/milestones
  • Auth
    HTTP bearer

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

Request body

namestring required

The name of the milestone (up to 30 characters).

milestone_datestring required

The date of the milestone in YYYY-MM-DD format.

Example request

{
  "name": "Website Redesign Launch",
  "milestone_date": "2024-01-15"
}

Response

Successful response

Changes

    • breaking

      added the new path request parameter site_id

    • breaking

      removed the success response with the status

    • info

      api operation id createMilestone was added

    • info

      api tag Milestones added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status