Method: instances.report

Full name: projects.locations.instances.report

Generate a report summarizing this chronicle instance.

HTTP request

GET https://chronicle.googleapis.com/v1alpha/{name}:report

Path parameters

Parameters
name

string

Required. The name of the chronicle instance to retrieve a report for. Format: {api_version}/projects/{project_id}/locations/{region}/instances/{instance}

Request body

The request body must be empty.

Response body

Response with a generated report for Instance.

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

JSON representation 
{
  "logs_count": string,
  "bytes_count": string,
  "available_data_interval": {
    object (Interval)
  },
  "raw_log_search_start_time": string,
  "available_udm_search_data_interval": {
    object (Interval)
  },
  "max_detection_time": string
}
Fields
logs_count

string (int64 format)

Total number of log lines ingested
bytes_count

string (int64 format)

Total bytes ingested
available_data_interval

object (Interval)

Interval representing the oldest and newest available data.
raw_log_search_start_time

string (Timestamp format)

Timestamp indicating earliest start date for raw log search.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
available_udm_search_data_interval

object (Interval)

The valid time range for a UDM search.
max_detection_time

string (Timestamp format)

The latest time at which a rule might have discovered a detection or alert.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.instances.report

For more information, see the IAM documentation.