Skip to main content
GET
/
events
/
analytics
Get analytics and insights across all event types
curl --request GET \
  --url http://sandbox.mintlify.com/events/analytics \
  --header 'Authorization: Bearer <token>'
{
  "totalEvents": 123,
  "eventsByType": {},
  "timeSeriesData": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "count": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

eventType
string

Filter by event type

timeframe
enum<string>

Analysis timeframe

Available options:
day,
week,
month,
quarter,
year

Response

200 - application/json

Event analytics response

totalEvents
integer

Total number of events in the period

eventsByType
object

Breakdown of events by type

timeSeriesData
object[]

Time series of event counts