vision

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.

post/api/projects/{project_id}/vision/scanners/{scanner_id}/backfills/

Request

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

Path parameters

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

scanner_idstring uuid required

Request body

window_startstring date-time required

Inclusive lower bound of the historical window to scan.

window_endstring date-time required

Exclusive upper bound of the window; clamped server-side to now, and for an experiment scanner to the experiment's end date.

max_total_creditsinteger required

The most this backfill may cost, in credits (1 credit = $0.01): pass the total_credits from the estimate the person agreed to. The create is rejected if the window now costs more.

Response

idstring uuid required
status'running' | 'paused_quota' | 'completed' | 'cancelled' required
  • running - Running
  • paused_quota - Paused (quota)
  • completed - Completed
  • cancelled - Cancelled
window_startstring date-time required

Inclusive lower bound of the historical window to scan.

window_endstring date-time required

Exclusive upper bound of the window; clamped to now at creation.

total_countinteger required

Unobserved candidates enumerated at creation; the ceiling is total_count x credits_per_observation.

dispatched_countinteger required
skipped_countinteger required

Candidates the walk stepped over because this scanner had already tried them. Counted at creation but never dispatched, so progress and remaining spend both have to account for them.

credits_per_observationinteger required

Per-observation credit price frozen at creation from the snapshot model.

succeeded_countinteger required

Observations from this backfill that succeeded.

failed_countinteger required

Observations from this backfill that failed.

ineligible_countinteger required

Sessions that turned out ineligible (too short, expired recording, ...).

in_flight_countinteger required

Observations from this backfill still pending or running.

created_atstring date-time required
finished_atstring date-time nullable required

When the backfill reached a terminal status (completed or cancelled).

Changes

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