Visualization

Get package visualization metadata with timeline

get

Returns metadata for a repository/branch including the commit timeline. The timeline contains commit IDs, timestamps, and ordering — suitable for building a timeline slider in the UI without loading snapshot data.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

releaseConfigPathstringRequiredExample: config

Responses

200

Metadata with timeline 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/metadata

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

No content

Upsert visualization metadata

put

Creates or updates visualization metadata for a repository/branch. Returns the metadataId needed for batch commit uploads.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Metadata upserted, returns metadataId

No content

403

Forbidden - Requires role: application

put/sfp/api/visualization/packages/metadata

PUT /sfp/api/visualization/packages/metadata HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get paginated commit snapshots

get

Returns commit snapshots with pagination. Each commit contains its package snapshots (~1-5KB). Default limit is 50, max is 200. Results are ordered newest-first by commit_order.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

offsetnumberOptionalExample: 0

limitnumberOptionalExample: 50

Responses

200

Paginated commit snapshots

No content

403

Forbidden - Requires role: member, application

404

No visualization data or project not found

get/sfp/api/visualization/packages/commits

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

No content

Batch upsert commit snapshots

post

Upserts a batch of commit snapshots for a given metadataId. The engine sends batches of ~100 commits at a time.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Commits upserted

No content

403

Forbidden - Requires role: application

post/sfp/api/visualization/packages/commits/batch

POST /sfp/api/visualization/packages/commits/batch HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get existing commit IDs for incremental collection

get

Returns the list of commit IDs already stored for a repository/branch. The engine uses this to skip commits that have already been processed.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

Responses

200

Existing commit IDs and metadataId

No content

403

Forbidden - Requires role: application

get/sfp/api/visualization/packages/commits/existing

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

No content

Get snapshots for a single commit

get

Returns the package snapshots for a specific commit ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

commitIdstringRequiredExample: abc1234

Query parameters

repositoryIdentifierstringRequiredExample: flxbl-io/sf-core

branchstringRequiredExample: main

Responses

200

Commit snapshots

No content

403

Forbidden - Requires role: member, application

404

Commit or project not found

get/sfp/api/visualization/packages/commits/{commitId}

GET /sfp/api/visualization/packages/commits/{commitId}?repositoryIdentifier=flxbl-io%2Fsf-core&branch=main 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

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

403

Forbidden - Requires role: member, application

get/sfp/api/visualization/packages/status

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

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

No content

403

Forbidden - Requires role: member, application

409

Visualization already in progress

post/sfp/api/visualization/packages/refresh

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

Last updated 2 hours ago

Was this helpful?