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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

releaseConfigPathstringRequiredExample: config

Responses

200

Visualization data if available, null otherwise

No content

400

Missing required parameters

403

Forbidden - Requires role: member, application

404

Project not found

get

/sfp/api/visualization/packages

HTTPcURLJavaScriptPython

GET /sfp/api/visualization/packages?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main&releaseConfigPath=config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

releaseConfigPathstringRequiredExample: config

Responses

200

Current visualization status

No content

400

Missing required parameters

403

Forbidden - Requires role: member, application

404

Project not found

get

/sfp/api/visualization/packages/status

HTTPcURLJavaScriptPython

GET /sfp/api/visualization/packages/status?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main&releaseConfigPath=config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

access-token

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

releaseConfigPathstringRequiredExample: config

maxCommitsnumberOptionalExample: 6000

Responses

202

Refresh triggered

400

Missing required parameters

403

Forbidden - Requires role: member, application

404

Project not found

409

Visualization already in progress

post

/sfp/api/visualization/packages/refresh

HTTPcURLJavaScriptPython

POST /sfp/api/visualization/packages/refresh?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main&releaseConfigPath=config HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content