- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
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 |
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 ( |
Fields | |
---|---|
logs_count |
Total number of log lines ingested |
bytes_count |
Total bytes ingested |
available_data_interval |
Interval representing the oldest and newest available data. |
raw_log_search_start_time |
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: |
available_udm_search_data_interval |
The valid time range for a UDM search. |
max_detection_time |
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: |
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.