Sessions

Search sessions

Returns the organisation's sessions across its sites, newest first by when they started, as a bounded keyset page. Every filter is optional and they combine. Needs analytics.sessions.read.

get/v1/sessions

Request

  • Base URL: https://api.ironfang.com/analytics
  • URL: https://api.ironfang.com/analytics/v1/sessions
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

cursorstring

The next_cursor of the previous page.

limitinteger
site_idstring uuid
fromstring date-time

Started at or after this time.

tostring date-time

Started before this time.

state'live' | 'active' | 'ended'

live (heard from in the last 90 seconds), active (not ended) or ended.

countrystring

Two-letter country code, upper case.

devicestring
Example:mobile
browserstring
Example:chrome
osstring
Example:windows
ipstring
Example:203.0.113.0/24

One address, or a network in CIDR notation.

entry_pathstring
Example:/apply

Entry paths starting with this.

visited_pathstring
Example:/pricing

Sessions that visited this page, by its path without a query string or fragment.

visitor_idstring uuid

One browser's sessions.

recording'with' | 'without'

with, sessions with a recording that can be played; without, the rest.

diagnostics'errors' | 'requests' | 'any'

Sessions with errors (uncaught, unhandled rejections or console errors), with failed requests (an error answer, no answer, a timeout or a resource that did not load; not an aborted one), or with either (any).

Response

A page of sessions

next_cursorstring required

Opaque cursor for the next page; empty on the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.