evaluations

Create a backfill: freeze the conditions, count the units, start the walk.

post/api/projects/{project_id}/evaluations/{evaluation_id}/backfills/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/evaluations/{evaluation_id}/backfills/
  • Auth: HTTP bearer

Path parameters

evaluation_idstring uuid required
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/.

Request body

window_startstring date-time required

Inclusive start of the window, by unit timestamp.

window_endstring date-time required

Exclusive end of the window. Values in the future are clamped to now.

rerun_existingboolean

Evaluate units again even when this evaluation already has a result for them.

Response

idstring uuid required

Backfill identifier.

status'running' | 'completed' | 'cancelled' required
  • running - Running
  • completed - Completed
  • cancelled - Cancelled
target'generation' | 'trace' | 'session' required
  • generation - Generation
  • trace - Trace
  • session - Session
window_startstring date-time required

Inclusive start of the window, by unit timestamp.

window_endstring date-time required

Exclusive end of the window.

rerun_existingboolean required

Whether units with an existing result are evaluated again.

total_countinteger required

Units matched at creation. Units that land in the window later can take dispatched_count and skipped_count past it.

dispatched_countinteger required

Units the backfill has started an evaluation for so far.

skipped_countinteger required

Units the live path had already covered, so nothing was dispatched.

failed_countinteger required

Units whose evaluation failed to start. They have no result and count toward remaining_count.

remaining_countinteger nullable required

Units still holding no result when the run finished, counted at that moment. Zero means the window is covered, whoever graded it.

created_atstring date-time required

When the backfill was created.

finished_atstring date-time nullable required

When the backfill reached a terminal status; null while it runs.

Changes

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