USusefathom
Events

List events

Changed on

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

Permissions: Requires read access to the site (all-sites-readonly, read:{site_id} or manage:{site_id}).

Returns: A list of event objects.

The currency field is returned as null on list responses. Set it with Set event currency.

get/sites/{site_id}/events

Request

  • Base URL
    https://api.usefathom.com/v1
  • URL
    https://api.usefathom.com/v1/sites/{site_id}/events
  • 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

Query parameters

limitinteger
Example:10

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

starting_afterstring

A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For example, if you make a list request and receive 10 objects ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page.

ending_beforestring

A cursor for use in pagination, working in the opposite direction to starting_after. ending_before is an object ID that defines your place in the list.

Response

Successful response

Changes

  • 50679caad756Revision changes
    • breaking

      added the new path request parameter site_id

    • info

      api operation id listEvents was added

    • info

      api tag Events added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status