Version: 0.0.3
Ion Channel's analysis reporting API
| Path | Operation | Description |
|---|---|---|
| /analysis/getAccountSummary | GET |
List of AnalysisSummary objects for a given account_id |
| /analysis/getAnalysis | GET |
Project object with analysis details |
| /analysis/getAnalysisSummary | GET |
AnalysisSummary object for a given project_id |
| /analysis/getProjectSummaries | GET |
AnalysisSummaries object containing an array of Summary objects |
the /analysis/getAccountSummary endpoint returns an object containing a list of project's latest summaries.
| id | the Account ID to get all project's latest summaries for |
query | string |
An object containing a list of summarized analyses for an account
No analysis was found for the submitted analysis_id
Unexpected error
The /analysis endpoint returns an object containing the analysis for a given account's project. If no analysis_id is provide, the reponse will include the latest.
| project_id | Project ID to get details for |
query | string | |
| format | Format for the returned reports (JSON, YAML) |
query | string | |
| account_id | Account ID to use for fetching the project details |
query | string | |
| analysis_id | Analysis ID for specific run of data and ruleset, unset will return the latest |
query | string |
An Analysis object
No analysis was found for the submitted project_id
Unexpected error
The /analysis/getAnalysisSummary endpoint returns an object containing analysis summaries for a given account's project. If no analysis_id is provided it will return the latest.
| project_id | Project ID to get details for |
query | string | |
| format | Format for the returned reports (JSON, YAML) |
query | string | |
| account_id | Account ID to use for fetching the project details |
query | string | |
| analysis_id | Analysis ID for specific run of data and ruleset, unset will return the latest |
query | string |
An AnalysisSummary object containing summarized analysis for a given run
No analysis was found for the submitted analysis_id
Unexpected error
The /analysis/getProjectSummaries endpoint returns and array of summary objects for a given project_id.
| project_id | Project ID to get details for |
query | string | |
| format | Format for the returned reports (JSON, YAML) |
query | string | |
| account_id | Account ID to use for fetching the project details |
query | string | |
| limit | Limit the number of rows in the response. To receive all rows set limit to 0. |
query | integer 10 | |
| offset | Starting row for responses (for pagination) |
query | integer |
An AnalysisSummaries object containing and array of summarized analyses for a given project_id
No analysis was found for the submitted analysis_id
Unexpected error
Unique identifier representing a specific summary
Description of analysis.
The current risk indicator of this analysis
Summary output of the project's content
Time of last updated
ID for the ruleset applied
Simple name for the applied ruleset
Time to complete analysis
Type of trigger for the analysis
Hash of the source trigger (e.g. commit hash)
Summary explanation for the trigger (e.g. commit comment)
Username or name of person responsible for trigger
Account ID of analysis owner
Id of the project this analysis belongs
Unique identifier representing a specific analysis
Name of the analysis?
Source type for the analysis (git|file)
Source endpoint for the analysis (git repo)
Source specifier for a source (git branch)
Short description of the analysis
Ion Channel risk rating
Code for the results of the scan [accepted|failed|finished]
Unique identifier representing a specific summary
Description of analysis.
The current risk indicator of this analysis
Summary output of the project's content
ID for the ruleset applied
Simple name for the applied ruleset
Time to complete analysis
Type of trigger for the analysis
Hash of the source trigger (e.g. commit hash)
Summary explanation for the trigger (e.g. commit comment)
Username or name of person responsible for trigger
The url of the current request
The url of the resource that was created
Url of the next data object
Url of the previous data object
Url of the last data object
Url of the first data object
Copyright info
Authors
API version
Last update of source data (optional)
Unique identifier representing a specific project
Name of the project?
Is the project active
Source type for the project (git|file)
Source endpoint for the project (git repo)
Source specifier for a source (git branch)
Short description of the project
Group chat channel for the project
Account ID of project owner
Governance ruleset ID associated with the project
Account ID of analysis owner
Id of the project this scan belongs
Unique identifier representing a specific analysis
The unique id for a scan
Short human readable description of the results of the analysis
The name of the scan type that was run
Summary of the scan result
Ion Channel risk rating