2022-07-28
▼ ▲ beyondcorp.projects.locations.insights.list
Path : v1alpha/{+parent}/insights
Parameters :
pageSize
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.
Location : query
Format : int32
Type : integer
orderBy
Description : Optional. Hint for how to order the results. This is currently ignored.
Type : string
Location : query
filter
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).
Location : query
Type : string
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
view
Description : Required. List only metadata or full data.
Type : string
Enum :
Enum Descriptions :
Location : query
parent
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 : ^projects/[^/]+/locations/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights
Parameter Order : parent
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
HTTP Method : GET
▼ ▲ beyondcorp.projects.locations.insights.configuredInsight
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
group
Location : query
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.
Type : string
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}`.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
endTime
Description : Required. Ending time for the duration for which insight is to be pulled.
Type : string
Format : google-datetime
Location : query
aggregation
Enum Descriptions :
Enum :
Location : query
Description : Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
Type : string
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
pageToken
Type : string
Description : Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location : query
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
startTime
Location : query
Description : Required. Starting time for the duration for which insight is to be pulled.
Format : google-datetime
Type : string
customGrouping.groupFields
Repeated : Yes
Location : query
Type : string
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.
Parameter Order : insight
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+insight}:configuredInsight
HTTP Method : GET
▼ ▲ beyondcorp.projects.locations.insights.get
Parameter Order : name
HTTP Method : 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.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
view
Type : string
Location : query
Description : Required. Metadata only or full data view.
Enum Descriptions :
Enum :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}
▼ ▲ beyondcorp.organizations.locations.insights.configuredInsight
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
pageToken
Description : Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location : query
Type : string
endTime
Location : query
Description : Required. Ending time for the duration for which insight is to be pulled.
Format : google-datetime
Type : string
startTime
Type : string
Format : google-datetime
Description : Required. Starting time for the duration for which insight is to be pulled.
Location : query
insight
Location : path
Type : string
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/[^/]+$
Required : Yes
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
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
customGrouping.groupFields
Repeated : Yes
Type : string
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
aggregation
Enum :
Description : Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
Enum Descriptions :
Type : string
Location : query
fieldFilter
Location : query
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).
Type : string
Parameter Order : insight
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
▼ ▲ beyondcorp.organizations.locations.insights.list
Parameters :
filter
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).
Type : string
Location : query
view
Location : query
Enum :
Enum Descriptions :
Description : Required. List only metadata or full data.
Type : string
parent
Required : Yes
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
Pattern : ^organizations/[^/]+/locations/[^/]+$
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return.
Type : string
orderBy
Description : Optional. Hint for how to order the results. This is currently ignored.
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. NOTE: Default page size is 50.
Location : query
HTTP Method : GET
Parameter Order : parent
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.
Path : v1alpha/{+parent}/insights
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights
▼ ▲ beyondcorp.organizations.locations.insights.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}
Parameter Order : name
HTTP Method : GET
Path : v1alpha/{+name}
Parameters :
name
Location : path
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/[^/]+$
Type : string
view
Type : string
Enum :
Description : Required. Metadata only or full data view.
Enum Descriptions :
Location : query
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.
▼ ▲ beyondcorp.projects.locations.insights.list
Path : v1alpha/{+parent}/insights
Parameters :
pageSize
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.
Location : query
Format : int32
Type : integer
orderBy
Description : Optional. Hint for how to order the results. This is currently ignored.
Type : string
Location : query
filter
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).
Location : query
Type : string
pageToken
Location : query
Type : string
Description : Optional. A token identifying a page of results the server should return.
view
Description : Required. List only metadata or full data.
Type : string
Enum :
Enum Descriptions :
Location : query
parent
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 : ^projects/[^/]+/locations/[^/]+$
Type : string
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights
Parameter Order : parent
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
HTTP Method : GET
▼ ▲ beyondcorp.projects.locations.insights.configuredInsight
Parameters :
pageSize
Type : integer
Location : query
Format : int32
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
group
Location : query
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.
Type : string
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}`.
Location : path
Type : string
Pattern : ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
endTime
Description : Required. Ending time for the duration for which insight is to be pulled.
Type : string
Format : google-datetime
Location : query
aggregation
Enum Descriptions :
Enum :
Location : query
Description : Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
Type : string
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
pageToken
Type : string
Description : Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location : query
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
startTime
Location : query
Description : Required. Starting time for the duration for which insight is to be pulled.
Format : google-datetime
Type : string
customGrouping.groupFields
Repeated : Yes
Location : query
Type : string
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.
Parameter Order : insight
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
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.
Scopes : https://www.googleapis.com/auth/cloud-platform
Path : v1alpha/{+insight}:configuredInsight
HTTP Method : GET
▼ ▲ beyondcorp.projects.locations.insights.get
Parameter Order : name
HTTP Method : 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.
Path : v1alpha/{+name}
Scopes : https://www.googleapis.com/auth/cloud-platform
Parameters :
view
Type : string
Location : query
Description : Required. Metadata only or full data view.
Enum Descriptions :
Enum :
name
Required : Yes
Location : path
Pattern : ^projects/[^/]+/locations/[^/]+/insights/[^/]+$
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
Flat Path : v1alpha/projects/{projectsId}/locations/{locationsId}/insights/{insightsId}
▼ ▲ beyondcorp.organizations.locations.insights.configuredInsight
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}:configuredInsight
HTTP Method : GET
Parameters :
pageSize
Format : int32
Location : query
Description : Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Type : integer
pageToken
Description : Optional. Used to fetch the page represented by the token. Fetches the first page when not set.
Location : query
Type : string
endTime
Location : query
Description : Required. Ending time for the duration for which insight is to be pulled.
Format : google-datetime
Type : string
startTime
Type : string
Format : google-datetime
Description : Required. Starting time for the duration for which insight is to be pulled.
Location : query
insight
Location : path
Type : string
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/[^/]+$
Required : Yes
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
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
customGrouping.groupFields
Repeated : Yes
Type : string
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
aggregation
Enum :
Description : Optional. Aggregation type. Available aggregation could be fetched by calling insight list and get APIs in `BASIC` view.
Enum Descriptions :
Type : string
Location : query
fieldFilter
Location : query
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).
Type : string
Parameter Order : insight
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
▼ ▲ beyondcorp.organizations.locations.insights.list
Parameters :
filter
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).
Type : string
Location : query
view
Location : query
Enum :
Enum Descriptions :
Description : Required. List only metadata or full data.
Type : string
parent
Required : Yes
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
Pattern : ^organizations/[^/]+/locations/[^/]+$
pageToken
Location : query
Description : Optional. A token identifying a page of results the server should return.
Type : string
orderBy
Description : Optional. Hint for how to order the results. This is currently ignored.
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. NOTE: Default page size is 50.
Location : query
HTTP Method : GET
Parameter Order : parent
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.
Path : v1alpha/{+parent}/insights
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights
▼ ▲ beyondcorp.organizations.locations.insights.get
Scopes : https://www.googleapis.com/auth/cloud-platform
Flat Path : v1alpha/organizations/{organizationsId}/locations/{locationsId}/insights/{insightsId}
Parameter Order : name
HTTP Method : GET
Path : v1alpha/{+name}
Parameters :
name
Location : path
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/[^/]+$
Type : string
view
Type : string
Enum :
Description : Required. Metadata only or full data view.
Enum Descriptions :
Location : query
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.