Visualization

Get package visualization data

get

Returns existing package visualization data from DocStore. Does NOT trigger a new analysis — use POST /visualization/packages/refresh for that. Returns null if no data has been collected yet.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
repositoryIdentifierstringRequiredExample: flxbl-io/sf-core
branchstringRequiredExample: main
releaseConfigPathstringRequiredExample: config
Responses
chevron-right
200

Visualization data if available, null otherwise

No content

get
/sfp/api/visualization/packages

No content

Get visualization status

get

Check the current status of package visualization for a repository/branch. Returns one of: never_ran, generating, available, or failed. Safe to poll — does not trigger any work.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
repositoryIdentifierstringRequiredExample: flxbl-io/sf-core
branchstringRequiredExample: main
releaseConfigPathstringRequiredExample: config
Responses
chevron-right
200

Current visualization status

No content

get
/sfp/api/visualization/packages/status

No content

Trigger visualization refresh

post

Triggers a new visualization data collection via Hatchet workflow. Returns a task execution ID for tracking. Returns 409 Conflict if a visualization job is already running for this repository/branch.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
repositoryIdentifierstringRequiredExample: flxbl-io/sf-core
branchstringRequiredExample: main
releaseConfigPathstringRequiredExample: config
maxCommitsnumberOptionalExample: 6000
Responses
post
/sfp/api/visualization/packages/refresh

No content

Last updated