2022-08-01
▼ ▲ beyondcorp.projects.locations.insights.list
Parameter Order: parent
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/insights
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas.
Parameters:
filter
Location: query
Type: string
Description: Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).
orderBy
Location: query
Type: string
Description: Optional. Hint for how to order the results. This is currently ignored.
parent
Description: Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}`
Type: string
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
pageSize
Location: query
Format: int32
Type: integer
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50.
pageToken
Location: query
Type: string
Description: Optional. A token identifying a page of results the server should return.
view
Enum:
Enum Descriptions:
Description: Required. List only metadata or full data.
Location: query
Type: string
HTTP Method: GET
Path: v1alpha/{+parent}/insights
▼ ▲ beyondcorp.projects.locations.insights.get
Path: v1alpha/{+name}
Parameters:
name
Location: path
Description: Required. The resource name of the insight using the form: `organizations/{organization_id}/locations/{location_id}/insights/{insight_id}` `projects/{project_id}/locations/{location_id}/insights/{insight_id}`
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
Required: Yes
view
Type: string
Location: query
Enum:
Description: Required. Metadata only or full data view.
Enum Descriptions:
Description: Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}
HTTP Method: GET
Parameter Order: name
▼ ▲ beyondcorp.projects.locations.insights.configuredInsight
HTTP Method: GET
Parameter Order: insight
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project.
Path: v1alpha/{+insight}:configuredInsight
Parameters:
group
Location: query
Type: string
Description: Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view.
pageToken
Description: Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location: query
Type: string
endTime
Type: string
Format: google-datetime
Location: query
Description: Required. Ending time for the duration for which insight is to be pulled.
pageSize
Format: int32
Location: query
Type: integer
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
customGrouping.groupFields
Repeated: Yes
Location: query
Description: Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here.
Type: string
aggregation
Location: query
Enum:
Enum Descriptions:
Type: string
Description: Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
fieldFilter
Type: string
Description: Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160).
Location: query
insight
Required: Yes
Description: Required. The resource name of the insight using the form: `organizations/{organization_id}/locations/{location_id}/insights/{insight_id}` `projects/{project_id}/locations/{location_id}/insights/{insight_id}`.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
Location: path
customGrouping.fieldFilter
Description: Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160).
Location: query
Type: string
startTime
Type: string
Format: google-datetime
Description: Required. Starting time for the duration for which insight is to be pulled.
Location: query
Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
▼ ▲ beyondcorp.organizations.locations.insights.get
Description: Gets the value for a selected particular insight with default configuration. The default aggregation level is 'DAILY' and no grouping will be applied or default grouping if applicable. The data will be returned for recent 7 days. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project. Setting the `view` to `BASIC` will only return the metadata for the insight.
HTTP Method: GET
Path: v1alpha/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Location: path
Type: string
Required: Yes
Description: Required. The resource name of the insight using the form: `organizations/{organization_id}/locations/{location_id}/insights/{insight_id}` `projects/{project_id}/locations/{location_id}/insights/{insight_id}`
Pattern: ^organizations/[^/]+/locations/[^/]+/insights/[^/]+$
view
Enum Descriptions:
Description: Required. Metadata only or full data view.
Type: string
Enum:
Location: query
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}
Parameter Order: name
▼ ▲ beyondcorp.organizations.locations.insights.configuredInsight
Parameters:
pageToken
Description: Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location: query
Type: string
fieldFilter
Description: Optional. Other filterable/configurable parameters as applicable to the selected insight. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160).
Location: query
Type: string
pageSize
Type: integer
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
customGrouping.fieldFilter
Location: query
Description: Optional. Filterable parameters to be added to the grouping clause. Available fields could be fetched by calling insight list and get APIs in `BASIC` view. `=` is the only comparison operator supported. `AND` is the only logical operator supported. Usage: field_filter="fieldName1=fieldVal1 AND fieldName2=fieldVal2". NOTE: Only `AND` conditions are allowed. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for the filtering the corresponding fields in this filter field. (These expressions are based on the filter language described at https://google.aip.dev/160).
Type: string
startTime
Format: google-datetime
Type: string
Description: Required. Starting time for the duration for which insight is to be pulled.
Location: query
endTime
Type: string
Description: Required. Ending time for the duration for which insight is to be pulled.
Format: google-datetime
Location: query
aggregation
Description: Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
Location: query
Enum:
Type: string
Enum Descriptions:
customGrouping.groupFields
Description: Required. Fields to be used for grouping. NOTE: Use the `filter_alias` from `Insight.Metadata.Field` message for declaring the fields to be grouped-by here.
Location: query
Type: string
Repeated: Yes
insight
Description: Required. The resource name of the insight using the form: `organizations/{organization_id}/locations/{location_id}/insights/{insight_id}` `projects/{project_id}/locations/{location_id}/insights/{insight_id}`.
Location: path
Type: string
Pattern: ^organizations/[^/]+/locations/[^/]+/insights/[^/]+$
Required: Yes
group
Description: Optional. Group id of the available groupings for the insight. Available groupings could be fetched by calling insight list and get APIs in `BASIC` view.
Location: query
Type: string
HTTP Method: GET
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
Parameter Order: insight
Path: v1alpha/{+insight}:configuredInsight
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the value for a selected particular insight based on the provided filters. Use the organization level path for fetching at org level and project level path for fetching the insight value specific to a particular project.
▼ ▲ beyondcorp.organizations.locations.insights.list
Flat Path: v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights
Parameters:
pageToken
Location: query
Description: Optional. A token identifying a page of results the server should return.
Type: string
view
Enum:
Enum Descriptions:
Location: query
Description: Required. List only metadata or full data.
Type: string
pageSize
Location: query
Format: int32
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50.
Type: integer
orderBy
Type: string
Location: query
Description: Optional. Hint for how to order the results. This is currently ignored.
parent
Type: string
Location: path
Description: Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}`
Required: Yes
Pattern: ^organizations/[^/]+/locations/[^/]+$
filter
Location: query
Type: string
Description: Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).
Description: Lists for all the available insights that could be fetched from the system. Allows to filter using category. Setting the `view` to `BASIC` will let you iterate over the list of insight metadatas.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1alpha/{+parent}/insights
HTTP Method: GET
Parameter Order: parent