Method: legacySoarSettings.legacyGetVisualSummaryRecords

Full name: projects.locations.instances.legacySoarSettings.legacyGetVisualSummaryRecords

legacySoarSettings.legacyGetVisualSummaryRecords returns the visual summary records.

HTTP request


Path parameters

Parameters
instance

string

Required. The instance to get the visual summary records for. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body must be empty.

Response body

Response message for LegacySoarSettingService.LegacyGetVisualSummaryRecords.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "payload": [
    {
      object (LegacyVisualSummaryFieldMetadataRecord)
    }
  ]
}
Fields
payload[]

object (LegacyVisualSummaryFieldMetadataRecord)

Optional. The visual summary records.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

LegacyVisualSummaryFieldMetadataRecord

Response message for LegacySoarSettingService.LegacyGetVisualSummaryRecords.

JSON representation 
{
  "fieldName": string,
  "sectionType": enum (LegacyVisualSummarySectionType),
  "id": integer,
  "creationTimeUnixTimeInMs": string,
  "modificationTimeUnixTimeInMs": string,
  "maxValue": integer,
  "isDescending": boolean,
  "isTypeBool": boolean
}
Fields
fieldName

string

Output only. The field name.
sectionType

enum (LegacyVisualSummarySectionType)

Output only. The section type.
id

integer

Optional. The visual summary records.
creationTimeUnixTimeInMs

string (int64 format)

Optional. The creation time.
modificationTimeUnixTimeInMs

string (int64 format)

Optional. The modification time.
maxValue

integer

Output only. The max value.
isDescending

boolean

Output only. Whether is descending.
isTypeBool

boolean

Output only. Whether is type bool.

LegacyVisualSummarySectionType

Visual summary section type.

Enums
ENTITIES Entities.
RELATIONS Events.