GET
/
sites
/
{site_id}
/
events
List events
curl --request GET \
  --url https://api.usefathom.com/v1/sites/{site_id}/events \
  --header 'Authorization: Bearer <token>'
{
  "object": "list",
  "url": [
    "/v1/sites/CDBUGS/events"
  ],
  "has_more": true,
  "data": [
    {
      "id": "signed-up-to-newsletter",
      "object": "event",
      "name": "Signed up to newsletter",
      "site_id": "CDBUGS",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Return a list of all events this site owns. Events are sorted by created_at ascending to allow you to do pagination with ease.

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.

Query Parameters

​
limit
integer
default:10

A limit on the number of objects to be returned, between 1 and 100.

Required range: 1 <= x <= 100
​
starting_after
string

A cursor for pagination/navigation. starting_after is an object ID. For example, if you requested 10 site objects, and the last item in the list was ABCDEF, you would send your next request with starting_after=ABCDEF.

​
ending_before
string

A cursor for pagination/navigation. ending_before is an object ID. For example, if you requested 10 site objects, and the first item in the list was ABCDEF, you would send your next request with ending_before=ABCDEF.

Response

200 - application/json

List of sites

The response is of type object.