Vision

For instructions on how to authenticate to use this endpoint, see API overview.

Endpoints

`GET`
`POST`
`GET`
`GET`
`GET`
`POST`
`GET`
`PATCH`
`DELETE`
`POST`
`POST`
`POST`
`GET`
`POST`
`GET`
`GET`
`POST`
`GET`
`POST`
`POST`

← Previous pageNext page →

Retrieve vision observations search suggestions

Example searches drawn from recent observations, for the Search tab's empty state. Reads what the scheduled refresher stored; search_viewed records the view separately so this GET has no side effect.

Required API key scopes

replay_scanner:readsession_recording:read

Query parameters

scanner_id
string

Response

Example request

GET /api/projects/:project_id/vision/observations/search_suggestions
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/observations/search_suggestions/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/observations/search_suggestions/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "queries": [
    "string"
  ]
}

Create vision observations search viewed

Record that the Search tab showed suggestions for this scope. The scheduled refresher serves viewed scanners first, so the stamp lives on a CSRF-protected POST rather than the read.

Required API key scopes

replay_scanner:readsession_recording:read

Request parameters

scanner_id
string

Example request

POST /api/projects/:project_id/vision/observations/search_viewed
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/observations/search_viewed/\
	-d scanner_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/observations/search_viewed/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"scanner_id": "string"
	}
).json()

Example response

Status 204 No response body

Retrieve environment vision quota

Required API key scopes

replay_scanner:read

Response

Example request

GET /api/projects/:project_id/vision/quota
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/quota/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/quota/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "credit_limit": 0,
  "credits_used": 0,
  "credits_settled": 0,
  "credits_reserved": 0,
  "remaining": 0,
  "exhausted": true,
  "period_start": "2019-08-24T14:15:22Z",
  "period_end": "2019-08-24T14:15:22Z",
  "projected_monthly_credits": 0,
  "scanners_monthly_credits": 0,
  "backfills_committed_credits": 0,
  "free_monthly_credits": 0
}

Retrieve environment vision quota spend series

Required API key scopes

replay_scanner:read

Response

Example request

GET /api/projects/:project_id/vision/quota/spend_series
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/quota/spend_series/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/quota/spend_series/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "period_start": "2019-08-24T14:15:22Z",
  "period_end": "2019-08-24T14:15:22Z",
  "days": [
    {
      "date": "2019-08-24",
      "credits": 0
    }
  ]
}

List all vision scanners

CRUD for Replay Vision scanners.

Required API key scopes

replay_scanner:read

Query parameters

created_by
string
emits_signals
boolean
enabled
string
experiment_id
string
limit
integer
offset
integer
order_by
string
One of: "-created_at""-created_by""-credits_this_month""-enabled""-name""-sampling_rate""-scanner_type""-updated_at""created_at""created_by""credits_this_month""enabled""name""sampling_rate""scanner_type""updated_at"
scanner_type
string
search
string
tags
string

Response

Example request

GET /api/projects/:project_id/vision/scanners
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "tags": [
        "string"
      ],
      "scanner_type": "monitor",
      "goal": "string",
      "creation_method": "ai",
      "scanner_config": null,
      "prompt_question": "string",
      "query": null,
      "sampling_rate": 1,
      "sampling_mode": "focused",
      "credit_limit": 1,
      "provider": "google",
      "model": "gemini-3.5-flash-lite",
      "enabled": true,
      "emits_signals": true,
      "experiment_targeting": {
        "experiment_id": 1,
        "variant": "string"
      },
      "scanner_version": 0,
      "estimated_monthly_observations": 0,
      "estimated_at": "2019-08-24T14:15:22Z",
      "credits_per_observation": 0,
      "estimated_monthly_credits": 0,
      "credits_this_month": 0,
      "observations_this_month": 0,
      "credits_used_against_limit": 0,
      "limit_reached": true,
      "sweep_throttle_factor": 0,
      "last_swept_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "updated_at": "2019-08-24T14:15:22Z",
      "user_access_level": "string"
    }
  ]
}

Create vision scanners

CRUD for Replay Vision scanners.

Required API key scopes

replay_scanner:writesession_recording:read

Request parameters

name
string
description
string
tags
array
scanner_type
goal
string | null
creation_method
scanner_config
query
sampling_rate
number
sampling_mode
credit_limit
integer | null
provider
model
enabled
boolean
emits_signals
boolean
experiment_targeting

Response

Example request

POST /api/projects/:project_id/vision/scanners
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/\
	-d name="string",\
	-d scanner_type=undefined,\
	-d scanner_config=undefined,\
	-d model=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/".format(
        project_id=project_id
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "scanner_type": "monitor",
  "goal": "string",
  "creation_method": "ai",
  "scanner_config": null,
  "prompt_question": "string",
  "query": null,
  "sampling_rate": 1,
  "sampling_mode": "focused",
  "credit_limit": 1,
  "provider": "google",
  "model": "gemini-3.5-flash-lite",
  "enabled": true,
  "emits_signals": true,
  "experiment_targeting": {
    "experiment_id": 1,
    "variant": "string"
  },
  "scanner_version": 0,
  "estimated_monthly_observations": 0,
  "estimated_at": "2019-08-24T14:15:22Z",
  "credits_per_observation": 0,
  "estimated_monthly_credits": 0,
  "credits_this_month": 0,
  "observations_this_month": 0,
  "credits_used_against_limit": 0,
  "limit_reached": true,
  "sweep_throttle_factor": 0,
  "last_swept_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "user_access_level": "string"
}

Retrieve vision scanners

CRUD for Replay Vision scanners.

Required API key scopes

replay_scanner:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/vision/scanners/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "scanner_type": "monitor",
  "goal": "string",
  "creation_method": "ai",
  "scanner_config": null,
  "prompt_question": "string",
  "query": null,
  "sampling_rate": 1,
  "sampling_mode": "focused",
  "credit_limit": 1,
  "provider": "google",
  "model": "gemini-3.5-flash-lite",
  "enabled": true,
  "emits_signals": true,
  "experiment_targeting": {
    "experiment_id": 1,
    "variant": "string"
  },
  "scanner_version": 0,
  "estimated_monthly_observations": 0,
  "estimated_at": "2019-08-24T14:15:22Z",
  "credits_per_observation": 0,
  "estimated_monthly_credits": 0,
  "credits_this_month": 0,
  "observations_this_month": 0,
  "credits_used_against_limit": 0,
  "limit_reached": true,
  "sweep_throttle_factor": 0,
  "last_swept_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "user_access_level": "string"
}

Update vision scanners

CRUD for Replay Vision scanners.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string

Request parameters

name
string
description
string
tags
array
scanner_type
goal
string | null
creation_method
scanner_config
query
sampling_rate
number
sampling_mode
credit_limit
integer | null
provider
model
enabled
boolean
emits_signals
boolean
experiment_targeting

Response

Example request

PATCH /api/projects/:project_id/vision/scanners/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl -X PATCH \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/\
	-d name="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.patch(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"name": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "scanner_type": "monitor",
  "goal": "string",
  "creation_method": "ai",
  "scanner_config": null,
  "prompt_question": "string",
  "query": null,
  "sampling_rate": 1,
  "sampling_mode": "focused",
  "credit_limit": 1,
  "provider": "google",
  "model": "gemini-3.5-flash-lite",
  "enabled": true,
  "emits_signals": true,
  "experiment_targeting": {
    "experiment_id": 1,
    "variant": "string"
  },
  "scanner_version": 0,
  "estimated_monthly_observations": 0,
  "estimated_at": "2019-08-24T14:15:22Z",
  "credits_per_observation": 0,
  "estimated_monthly_credits": 0,
  "credits_this_month": 0,
  "observations_this_month": 0,
  "credits_used_against_limit": 0,
  "limit_reached": true,
  "sweep_throttle_factor": 0,
  "last_swept_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "user_access_level": "string"
}

Delete vision scanners

CRUD for Replay Vision scanners.

Required API key scopes

replay_scanner:write

Path parameters

id
string

Example request

DELETE /api/projects/:project_id/vision/scanners/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl  -X DELETE \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.delete(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
)

Example response

Status 204 No response body

Create vision scanners affected cohort

Save the users this scanner matched as a static cohort, for surveys, funnels, and retention analysis.

Required API key scopes

replay_scanner:readsession_recording:readcohort:write

Path parameters

id
string

Request parameters

window_days
integer
Default: 30
verdict
tag
string | null
min_score
number | null
max_score
number | null

Response

Example request

POST /api/projects/:project_id/vision/scanners/:id/affected_cohort
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/affected_cohort/\
	-d window_days="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/affected_cohort/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"window_days": "integer"
	}
).json()

Example response

Status 201

RESPONSE
{
  "cohort_id": 0,
  "name": "string",
  "users_in_cohort": 0,
  "window_days": 0
}

Create vision scanners bulk observe

Apply this scanner to many sessions on demand. Starts as many as fit under the in-flight caps and monthly credit quota, reporting the rest as skipped rather than failing the batch.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string

Request parameters

session_ids
array

Response

Example request

POST /api/projects/:project_id/vision/scanners/:id/bulk_observe
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/bulk_observe/\
	-d session_ids="array"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/bulk_observe/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_ids": "array"
	}
).json()

Example response

Status 202

RESPONSE
{
  "started": 0,
  "results": [
    {
      "session_id": "string",
      "scan_outcome": "started"
    }
  ]
}

Create vision scanners duplicate

Copy a scanner into a new disabled scanner named "<name> (copy)".

Copies the stored model row rather than the serializer's read representation, so a query that no longer validates survives the copy; duplicating through the create endpoint would silently drop it. Experiment targeting is the exception and follows the read path instead. Unlike create, no digest is provisioned: the copy starts disabled and unreviewed.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string

Response

Example request

POST /api/projects/:project_id/vision/scanners/:id/duplicate
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/duplicate/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/duplicate/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "tags": [
    "string"
  ],
  "scanner_type": "monitor",
  "goal": "string",
  "creation_method": "ai",
  "scanner_config": null,
  "prompt_question": "string",
  "query": null,
  "sampling_rate": 1,
  "sampling_mode": "focused",
  "credit_limit": 1,
  "provider": "google",
  "model": "gemini-3.5-flash-lite",
  "enabled": true,
  "emits_signals": true,
  "experiment_targeting": {
    "experiment_id": 1,
    "variant": "string"
  },
  "scanner_version": 0,
  "estimated_monthly_observations": 0,
  "estimated_at": "2019-08-24T14:15:22Z",
  "credits_per_observation": 0,
  "estimated_monthly_credits": 0,
  "credits_this_month": 0,
  "observations_this_month": 0,
  "credits_used_against_limit": 0,
  "limit_reached": true,
  "sweep_throttle_factor": 0,
  "last_swept_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "updated_at": "2019-08-24T14:15:22Z",
  "user_access_level": "string"
}

Retrieve vision scanners impact

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

Required API key scopes

replay_scanner:readsession_recording:read

Path parameters

id
string

Query parameters

max_score
number | null
min_score
number | null
tag
string | null
verdict
string | null
One of: "yes""no""inconclusive"
window_days
integer
Default: 30

Response

Example request

GET /api/projects/:project_id/vision/scanners/:id/impact
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/impact/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/impact/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "affected_sessions": 0,
  "affected_users": 0,
  "sessions_without_user": 0,
  "window_days": 0
}

Create vision scanners observe

Apply this scanner to one specific session, on demand. Returns 202 with the workflow handle.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string

Request parameters

session_id
string

Response

Example request

POST /api/projects/:project_id/vision/scanners/:id/observe
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/observe/\
	-d session_id="string"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/observe/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"session_id": "string"
	}
).json()

Example response

Status 200

RESPONSE
{
  "observation_id": "d5b663f3-1b87-4f94-9f66-dbd8d5553132"
}

Status 202

RESPONSE
{
  "workflow_id": "string"
}

Status 503 The observation workflow couldn't be started.

RESPONSE
{
  "detail": "string"
}

Retrieve vision scanners self driving stats

What self-driving did with this scanner's signals: reports contributed to and PRs opened.

Required API key scopes

replay_scanner:readtask:read

Path parameters

id
string

Response

Example request

GET /api/projects/:project_id/vision/scanners/:id/self_driving_stats
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:id/self_driving_stats/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{vision-2_id}/self_driving_stats/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "signals_emitted": 0,
  "reports_contributed": 0,
  "prs_opened": 0,
  "prs_merged": 0,
  "reports": [
    {
      "id": "string",
      "title": "string",
      "status": "string"
    }
  ],
  "pull_requests": [
    {
      "url": "string",
      "merged": true
    }
  ]
}

List all vision scanners backfills

Historical backfills of a scanner over a closed time window (nested under a scanner).

Required API key scopes

replay_scanner:readsession_recording:read

Path parameters

scanner_id
string

Query parameters

limit
integer
offset
integer

Response

Example request

GET /api/projects/:project_id/vision/scanners/:scanner_id/backfills
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:scanner_id/backfills/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/".format(
        project_id=project_id,
		scanner_id="<the scanner id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "running",
      "window_start": "2019-08-24T14:15:22Z",
      "window_end": "2019-08-24T14:15:22Z",
      "total_count": 0,
      "dispatched_count": 0,
      "skipped_count": 0,
      "credits_per_observation": 0,
      "succeeded_count": 0,
      "failed_count": 0,
      "ineligible_count": 0,
      "in_flight_count": 0,
      "created_by": {
        "id": 0,
        "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
        "distinct_id": "string",
        "first_name": "string",
        "last_name": "string",
        "email": "user@example.com",
        "is_email_verified": true,
        "hedgehog_config": {},
        "role_at_organization": "engineering"
      },
      "created_at": "2019-08-24T14:15:22Z",
      "finished_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Create vision scanners backfills

Create a backfill: freeze the scanner config, enumerate the exact candidate set, start the tick schedule.

The enumeration reruns here rather than trusting the client-confirmed estimate: the count is billing-relevant, so the authoritative value is computed server-side at creation time. New settled sessions between estimate and confirm can nudge total_count slightly.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

scanner_id
string

Request parameters

window_start
string
window_end
string
max_total_credits
integer

Response

Example request

POST /api/projects/:project_id/vision/scanners/:scanner_id/backfills
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:scanner_id/backfills/\
	-d window_start="string",\
	-d window_end="string",\
	-d max_total_credits="integer"
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/".format(
        project_id=project_id,
		scanner_id="<the scanner id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={
		"window_start": "string",
		"window_end": "string",
		"max_total_credits": "integer"
	}
).json()

Example response

Status 201

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "window_start": "2019-08-24T14:15:22Z",
  "window_end": "2019-08-24T14:15:22Z",
  "total_count": 0,
  "dispatched_count": 0,
  "skipped_count": 0,
  "credits_per_observation": 0,
  "succeeded_count": 0,
  "failed_count": 0,
  "ineligible_count": 0,
  "in_flight_count": 0,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z"
}

Retrieve vision scanners backfills

Historical backfills of a scanner over a closed time window (nested under a scanner).

Required API key scopes

replay_scanner:readsession_recording:read

Path parameters

id
string
scanner_id
string

Response

Example request

GET /api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl \
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id/
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.get(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/{vision-2_id}/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>",
		scanner_id="<the scanner id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "window_start": "2019-08-24T14:15:22Z",
  "window_end": "2019-08-24T14:15:22Z",
  "total_count": 0,
  "dispatched_count": 0,
  "skipped_count": 0,
  "credits_per_observation": 0,
  "succeeded_count": 0,
  "failed_count": 0,
  "ineligible_count": 0,
  "in_flight_count": 0,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z"
}

Create vision scanners backfills cancel

Stop an active backfill; already-dispatched observations finish, nothing new dispatches.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string
scanner_id
string

Request parameters

Response

Example request

POST /api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id/cancel
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id/cancel/\
	-d status=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/{vision-2_id}/cancel/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>",
		scanner_id="<the scanner id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "window_start": "2019-08-24T14:15:22Z",
  "window_end": "2019-08-24T14:15:22Z",
  "total_count": 0,
  "dispatched_count": 0,
  "skipped_count": 0,
  "credits_per_observation": 0,
  "succeeded_count": 0,
  "failed_count": 0,
  "ineligible_count": 0,
  "in_flight_count": 0,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z"
}

Create vision scanners backfills resume

Restart a backfill that paused when the monthly quota ran out.

Required API key scopes

replay_scanner:writesession_recording:read

Path parameters

id
string
scanner_id
string

Request parameters

Response

Example request

POST /api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id/resume
export POSTHOG_PERSONAL_API_KEY=[your personal api key]
curl 
    -H 'Content-Type: application/json'\
    -H "Authorization: Bearer $POSTHOG_PERSONAL_API_KEY" \
    <ph_app_host>/api/projects/:project_id/vision/scanners/:scanner_id/backfills/:id/resume/\
	-d status=undefined
api_key = "[your personal api key]"
project_id = "[your project id]"
response = requests.post(
    "<ph_app_host>/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/{vision-2_id}/resume/".format(
        project_id=project_id,
		vision-2_id="<the vision-2 id>",
		scanner_id="<the scanner id>"
    ),
    headers={"Authorization": "Bearer {}".format(api_key)},
	data={}
).json()

Example response

Status 200

RESPONSE
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "status": "running",
  "window_start": "2019-08-24T14:15:22Z",
  "window_end": "2019-08-24T14:15:22Z",
  "total_count": 0,
  "dispatched_count": 0,
  "skipped_count": 0,
  "credits_per_observation": 0,
  "succeeded_count": 0,
  "failed_count": 0,
  "ineligible_count": 0,
  "in_flight_count": 0,
  "created_by": {
    "id": 0,
    "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
    "distinct_id": "string",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "is_email_verified": true,
    "hedgehog_config": {},
    "role_at_organization": "engineering"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "finished_at": "2019-08-24T14:15:22Z"
}

← Previous pageNext page →