This feature is paid only. To view available plans, please see this page.

List Event Types

Returns the list of all available event types. Some documented event types may not be returned if your Fullstory plan does not support them. If a returned event definition indicates that it has subcategories, that means that you must supply a subcategory when creating an endpoint that receives that type of event. You can get the list of available subcategories via the List Event Subcategories API.

Responses

200

---

A successful response.

Schema

Example

---

Schema

event_defs object[] optional
The list of event type definitions, up to the requested limit.
Array [
event_name string optional
The name of an event.
display_name string optional
A user-friendly display name for this kind of event.
has_subcategories boolean optional
True if this kind of event has subcategories.
]

{
  "eventDefs": [
    {
      "eventName": "note.created",
      "displayName": "Note Created",
      "hasSubcategories": false
    },
    {
      "eventName": "segment.trend.alert",
      "displayName": "Segment Alert",
      "hasSubcategories": true
    },
    {
      "eventName": "nativemobile.event.crash",
      "displayName": "Native Mobile Crash",
      "hasSubcategories": false
    },
    {
      "eventName": "recording.event.custom",
      "displayName": "Custom Event",
      "hasSubcategories": true
    }
  ]
}

Returned when invalid input has been provided. Fix the issue and retry.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "uid is required",
  "code": "required_field"
}

Returned when access to the resource is unauthorized.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "access is unauthorized",
  "code": "unauthorized"
}

Returned when access is not allowed due to insufficient permissions.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "insufficient permissions",
  "code": "forbidden"
}

Returned when the resource does not exist.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Requested resource does not exist",
  "code": "resource_not_found"
}

Returned when the client has exceeded the rate limit for this endpoint.

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Too many requests. Client has exceeded the rate limit for this endpoint.",
  "code": "too_many_requests"
}

Returned when a server error is encountered

Schema

Example

---

Schema

message string required

Long form description of what went wrong

code string required

A short snake-cased value that is safe to handle programmatically

{
  "message": "Server error was encountered",
  "code": "server_error"
}

Loading...