engineering_analytics
engineering_analytics

What one GitHub Actions job's log says it did: cache restores (hit, older cache, miss, restore failed) and migrations applied, for the job and per step. Reads the log from GitHub on demand. Only a completed job's answer is cached. log_read is false, never an error, when there is no log to read: a Depot CI job, a job the source does not hold, an expired log, or a failed fetch.

get/api/projects/{project_id}/engineering_analytics/job_log_insights/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/engineering_analytics/job_log_insights/
  • 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/.

Query parameters

ci_engine'github_actions' | 'depot_ci'

CI engine. Required when job_id exists in both engines. Only GitHub Actions job logs are read.

  • github_actions - GitHub Actions
  • depot_ci - Depot CI
job_idinteger required

Job id to read the log of; a row id from workflow_jobs.

repostring required

'owner/name' repository the job ran in.

run_idinteger required

Workflow run id the job belongs to.

source_idstring uuid

Connected GitHub data warehouse source to read from. Defaults to the source connected for repo.

Response

log_readboolean required

False when no log was read: a Depot CI job, a job the source does not hold, a log GitHub no longer keeps, or a failed fetch. Empty badges then mean 'unknown', not 'nothing found'.

attributed_to_stepsboolean required

False when the log's step markers did not line up with the job's steps, so the badges are reported for the job only.

log_truncatedboolean

True when only part of the log was parsed, because the log is too large or its download took too long. The badges are then a lower bound: an outcome in the part that was not parsed is missing.

Changes

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