vision

Start scans for named sessions from code, and read their results back through one request id.

get/api/projects/{project_id}/vision/requests/{id}/

Request

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

Path parameters

idstring uuid required

A UUID string identifying this replay observation request.

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

Response

idstring uuid required

Request ID. Poll GET /vision/requests/{id}/ with it.

status'running' | 'completed' required
  • running - Running
  • completed - Completed
scanner_idstring uuid nullable required

The scanner the sessions were scanned with. For an inline question this is a hidden scanner, shared by every request that asks the same question. Null when nothing could start.

referencestring required

The reference sent with the request.

created_atstring date-time required

When the request was made.

Changes

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