Get Session Events

Return the full set of captured events for a specified Session

Available for Fullstory customers who have purchased Data Direct. This API is still in Beta and is subject to change.

Path Parameters

session_id string required

The UTF-8 encoded ID of the session for which to generate context data. To retrieve the Session ID you may use the appropriate Get Session Details API for Web, iOS, or Android. As Session IDs include : separators the ID must be URL encoded using the %3A substitution.

Query Parameters

enable_event_cache boolean optional

Enable cached event responses from previous processing requests to be returned, to minimize latency when no new data has been received. If cached responses are used then updates to Elements, Events, Pages, and other configuration changes may not be reflected.

Responses

200

---

JSON object containing a list of session events based on the Events model.

Schema

Example

---

Schema

any

{
  "events": [
    {
      "device_id": "17117",
      "session_id": "5916567459329906423",
      "view_id": "4376064173749384629",
      "event_time": "2024-04-03T17:06:12.290Z",
      "event_type": "navigate",
      "event_properties": {
        "navigate_reason": "navigate",
        "event_definition_id": "Navigate-Login-Event",
        "additional_event_definition_ids": []
      },
      "source_type": "web",
      "source_properties": {
        "user_agent": {
          "raw_user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/123.0.0.0 Safari/537.36",
          "device": "Desktop",
          "operating_system": "OS X",
          "browser": "Chrome",
          "browser_version": "123.0.0.0"
        },
        "url": {
          "full_url": "https://app.fullstory.com/login/?dest=%2Fui",
          "host": "app.fullstory.com",
          "path": "/login/",
          "query": {
            "dest": {
              "values": [
                "/ui"
              ]
            }
          }
        },
        "initial_referrer": null
      }
    }
  ]
}

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": "session_id 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. A Retry-After header will be included with the response. This header will contain the number of seconds that you should wait before attempting to send another request.

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...