Visualization

Get package visualization data

get

Retrieves package visualization data for a repository/branch. This endpoint: - Returns existing data if available in DocStore - If no data exists, triggers the visualization flow AND creates a daily schedule - Returns a pending status with job ID when flow is triggered

    The visualization flow analyzes git history to track package evolution over time,
    extracting package metadata from sfdx-project.json changes across commits.

    Once a schedule is created, data is automatically refreshed daily at 2 AM UTC.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core
branchstringRequired

Branch name to analyze

Example: main
releaseConfigPathstringRequired

Path to release config directory (contains YAML files defining domains)

Example: config
maxCommitsnumberOptional

Maximum number of commits to analyze (default: 6000)

Example: 6000
Responses
chevron-right
200

Visualization data or pending status

application/json
get
/sfp/api/visualization/packages

Force refresh package visualization data

post

Triggers a new visualization data collection regardless of existing data. Use this endpoint when you need to refresh the data immediately outside of the scheduled updates. Returns a pending status with job ID to track the refresh operation.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
repositoryIdentifierstringRequired

Repository identifier in format owner/repo

Example: flxbl-io/sf-core
branchstringRequired

Branch name to analyze

Example: main
releaseConfigPathstringRequired

Path to release config directory

Example: config
maxCommitsnumberOptional

Maximum number of commits to analyze (default: 6000)

Example: 6000
Responses
chevron-right
200

Refresh operation started

application/json
post
/sfp/api/visualization/packages/refresh

Last updated