Sign in

v1

latestOpenAPI 3.0.02026-07-14198572488.4 KB
Activity

List Activity Events

List and Search events that took place on the site

get/v1/sites/{id}/activity/events

Path parameters

idinteger required

ID of the Site you are interacting with

Example:8880000888

Query parameters

authorstring
pageinteger

Page of results to include (default = 1)

per_pageinteger

How many results to include in each page (default = 10)

date_fromstring

Earliest date to show results for. Format YYYY-MM-DD with optional Thh:mm:ss.mmmZ

Example:2024-01-01T12:01:05.986Z
date_tostring

Latest date to show results for. Format YYYY-MM-DD with optional Thh:mm:ss.mmmZ

Example:2024-01-31
duration'30m' | '1h' | '6h' | '12h' | '24h' | '72h' | '7d' | '30d'

Duration that the listed data is for (m = minutes, h = hours, d = days)

Example:7d
ipstring
event_typestring
actionstring
display_namestring
user_emailstring
user_loginstring
labelstring

Response

OK

successboolean

whether the request succeeded

errorsstring[]
messagesstring[] nullable

Example response

{
  "success": true,
  "errors": [],
  "messages": [],
  "metadata": {
    "page": 1,
    "page_size": 10,
    "total": 150
  }
}