History Events

Records the usage of the Browser's History API during an Analysis.

version  : 1.0.0
stability: stable

Definition

Record

The History Events's record implements the Record's interface:

interface Record {
  url: string;
  type: HistoryEventType; // "BACK" | "FORWARD" | "GO" | "PUSH_STATE" | "REPLACE_STATE"
  data: string;
  trigger: string;
  requestId: string;
  frameId: string;
  targetVersion: string;
  timestamp: MonotonicTime;
}

Fields

`url`

version  : 1.0.0
stability: stable

url: string;

The URL of the page gathered when the event occurs.

`type`

version  : 1.0.0
stability: stable

type: HistoryEventType;

enum HistoryEventType {
  Back = "BACK",
  Forward = "FORWARD",
  Go = "GO",
  PushState = "PUSH_STATE",
  ReplaceState = "REPLACE_STATE",
}

The history's event that triggered the creation of the record as defined by W3C History Interface.

`data`

version  : 1.0.0
stability: stable

data: string;

The data passed along with the event.

`trigger`

version  : 1.0.0
stability: experimental

trigger: string;

When defined, the trigger reports the action that creates the History Events.

`requestId`

version  : 1.0.0
stability: stable

requestId: string;

The unique network Request's identifier in which the event was recorded.

⚠️ Caution: In some cases such as in a redirection context, this identifier could be shared by more than one entry:
[
  {
    "requestId": "10.1",
    "status": "302"
  },
  {
    "requestId": "10.1",
    "status": "200"
  }
]

`frameId`

version  : 1.0.0
stability: stable

frameId: string;

The Frame identifier in which the event was recorded.

`targetVersion`

version  : 1.0.0
stability: stable

targetVersion: string;

The Target version during which the event was recorded.

`timestamp`

version  : 1.0.0
stability: stable

timestamp: MonotonicTime;

An MonotonicTime that reflects the time when the event was recorded.

Sample

{
  "name": "history-events",
  "records": [
    {
      "url": "https://example.com",
      "type": "REPLACE_STATE",
      "data": "{\"foo\":\"bar\"}",
      "trigger": "",
      "requestId": "6A84237A55993581955FEBCCBED0D402",
      "frameId": "C9FB7BD57BBC8502412B9558A97A580D",
      "targetVersion": "8",
      "timestamp": "2375.395531"
    }
  ]
}

Docs