vision

Affected sessions and users for this scanner over the trailing window.

get/api/projects/{project_id}/vision/scanners/{id}/impact/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/vision/scanners/{id}/impact/
  • Auth: HTTP bearer

Path parameters

idstring uuid required

A UUID string identifying this replay scanner.

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Query parameters

max_scorenumber double nullable

Scorer scanners only: count sessions scoring at or below this value.

min_scorenumber double nullable

Scorer scanners only: count sessions scoring at or above this value. Scorers require min_score and/or max_score. Not applicable to other scanner types.

tagstring nullable

Classifier scanners only, required for them: count sessions carrying this tag (fixed or freeform). Not applicable to other scanner types.

verdict'yes' | 'no' | 'inconclusive' | 'null' nullable

Monitor scanners only: count sessions with this verdict. Defaults to yes. Not applicable to other scanner types.

  • yes - Yes
  • no - No
  • inconclusive - Inconclusive
window_daysinteger

Trailing window of observations to count. Defaults to 30 days.

Response

affected_sessionsinteger required

Distinct sessions with an affected observation in the window. For monitors only observations with the requested verdict count (yes by default); for other scanner types every succeeded observation counts.

affected_usersinteger required

Distinct users behind the affected sessions, by distinct ID. May include anonymous device IDs when the recorded sessions were not identified.

sessions_without_userinteger required

Affected sessions whose recording carried no distinct ID at all.

window_daysinteger required

Trailing window the counts cover, in days.

Changes

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