Analysis
version : 0.0.0
stability : stable
Objects
Analysis
Fields
| Name | Type | Description |
|---|---|---|
| organization | Organization! | The organization of the analysis. |
| account | Account! | The account of the Analysis. |
| owner | User! | The user of the analysis. |
| project | Project | The project of the analysis. |
| id | ID! | The ID of the analysis. |
| name | String | The name of the analysis. |
| content | String | The URL/HTML snippet of the analysis. |
| source | AnalysisSource! | The source of the analysis. |
| status | Status! | The status of the analysis. |
| initialTime | DateTime! | The time of creation of the Analysis |
| doneTime | DateTime | The time of the last update of the analysis. |
| device | Device | The device of the analysis. |
| location | Location | The location of the analysis. |
| violations | [String] | The violations of the Analysis |
| violation | Boolean | Whether the analysis has any violation. |
| report | Report | The report location of the analysis. |
| alertViolations | [String] | The violations that will generate an alert for the analysis. |
| alert | Boolean | Whether the analysis has any alert. |
| notifications | [AnalysisNotification] | The notifications of the analysis. |
| preset | PresetList! | The preset of the Analysis. |
| whitelistViolations | [String] | The violations that will be whitelisted for the analysis. |
| screenshots | [String] | The screenshots of the analysis |
Report
Fields
| Name | Type | Description |
|---|---|---|
| url | String! | The report full URL. |
| base | String! | The report base. |
| path | String! | The report path. |
AnalysisNotification
Fields
| Name | Type | Description |
|---|---|---|
| trigger | String! | The trigger for the analysis's notification. |
| uri | String! | The URI to be fired for the analysis's notification. |
AnalysisEdge
Fields
| Name | Type | Description |
|---|---|---|
| cursor | ID! | - |
| node | Analysis | - |
PageInfo
Information about type pagination in a connection. Fields
| Name | Type | Description |
|---|---|---|
| startCursor | ID | When paginating backwards, the cursor to continue. |
| endCursor | ID | When paginating forwards, the cursor to continue. |
| hasNextPage | Boolean! | When paginating forwards, are there more items? |
| hasPreviousPage | Boolean! | When paginating backwards, are there more items? |
AnalysisConnection
Fields
| Name | Type | Description |
|---|---|---|
| edges | [AnalysisEdge]! | - |
| nodes | [Analysis]! | - |
| pageInfo | PageInfo! | - |
Queries
analysis
Returns: Analysis
Arguments
| Name | Type | Description |
|---|---|---|
| id | String! | - |
analyses
Returns: AnalysisConnection
Arguments
| Name | Type | Description |
|---|---|---|
| first | Int! | Returns the first n elements from the list. |
| after | String | Returns the elements in the list that come after the specified global ID. |
| devices | [String] | A devices to filter analysis by. |
| term | String | A term to search for. |
| locations | [String] | List of locations to filter analysis by. |
| locationType | LocationType | A location type to filter analysis by. |
| source | String | Source to filter analysis by. |
| status | String | Status to filter analysis by. |
| project | String | Project to filter analysis by. |
| alert | Boolean | Get only analysis with alerts. |
| violation | Boolean | Get only analysis with violations. |
| violations | [String] | Get only analysis with particular violations. |
| order | Order | Sort of the analysis. |
| initDate | DateTime | Initial date to filter analysis by. |
| endDate | DateTime | End date to filter analysis by. |
Mutations
createAnalysis
Returns: Analysis
Arguments
| Name | Type | Description |
|---|---|---|
| input | CreateAnalysisMutationInput! | - |
Inputs
CreateAnalysisMutationInput
Fields
| Name | Type | Description | Default | |
|---|---|---|---|---|
| name | ConstraintString | The name of the analysis, allowed characters are alphanumeric, whitespace as well as -_() | .,/:+# (max 64 characters) | - |
| content | ConstraintString | The URL/HTML snippet to analyze | - | |
| device | ConstraintString | The Device of the Analysis | - | |
| location | LocationInput | The Location of the Analysis | - | |
| notifications | [String] | The Notifications of the Analysis | - | |
| alertRule | ConstraintString | The alert rule for the Analysis | - | |
| preset | PresetList | The preset of the Analysis. | - |