Recordings

Search recordings

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

get/v1/recordings

Request

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

Query parameters

cursorstring

The next_cursor of the previous page.

limitinteger
site_idstring uuid
fromstring date-time

Created at or after this time.

tostring date-time

Created before this time.

statestring
Example:ready,partial

One state, or several separated by commas.

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

Recordings that showed this page at any point, by its path without a query string or fragment. Pages are indexed when a recording is processed for heatmaps, shortly after it ends; until then it does not match.

visitor_idstring uuid

One browser's recordings, by the visitor id on any of them.

Response

A page of recordings

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.