Summary
Python SDK reference for the analyses.summary resource
Note
The Bevor SDK is coming soon. This page previews its planned Python interface.
Access this resource from client.analyses.summary. Both async and sync clients expose the same methods.
user_breakdown
GET /security/summary/users
result = await client.analyses.summary.user_breakdown()Arguments:
project_idID | Nonequerydefault:
NoneReturns: ResultsResponse[UserBreakdownSchema]
show properties (1)hide properties (1)
resultsarray of UserBreakdownSchemashow properties (5)hide properties (5)
userUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequiredn_versionsintegerlast_analysis_atOptional[string]n_remediatedintegern_validatedintegerhistory_breakdown
GET /security/summary/projects/{project_id}/history
result = await client.analyses.summary.history_breakdown(
project_id=project_id,
)Arguments:
project_idIDpathrequiredReturns: ResultsResponse[AnalysisTrendPoint]
show properties (1)hide properties (1)
resultsarray of AnalysisTrendPointshow properties (7)hide properties (7)
idstringrequiredanalysis_idstringrequiredindintegerrequiredcreated_atstringrequiredn_remediatedintegern_acknowledgedintegern_non_acknowledgedintegernetwork
GET /security/summary/projects/{project_id}/network
result = await client.analyses.summary.network(
project_id=project_id,
)Arguments:
project_idIDpathrequiredReturns: ResultsResponse[AnalysisNetworkPoint]
show properties (1)hide properties (1)
resultsarray of AnalysisNetworkPointshow properties (12)hide properties (12)
idstringrequiredanalysis_idstringrequiredindintegerrequiredcreated_atstringrequiredis_ownerbooleanrequirednamestringrequiredproject_slugstringrequiredproject_idstringrequiredmerged_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredforked_from_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequiredparent_versionOptional[AnalysisVersionRef]show properties (2)hide properties (2)
idstringrequiredanalysis_idstringrequireduserUserSchemarequiredshow properties (4)hide properties (4)
idstringrequiredis_selfbooleanrequiredcreated_atstringrequiredusernamestringrequired