Full name: projects.locations.instances.analytics.entities.analyticValues.list
Lists analytic values. An analytic value refers to a data point (numeric value & interval) for a specific entity and analytic. The API returns matching AnalyticValues for the desired entity and analytic, according to the following filters:
lookback_interval: Filter by the lookback interval, up to 90 days. Example:
lookback_interval.start_time greater than or equal to
"2023-08-10T14:20:59.950218416Z" AND lookback_interval.end_time less
than or equal to "2023-08-17T14:20:59.950219626Z"
aggregateFunction: Filter by the aggregate function. This represents the mathematical function used to calculate the analytic value. Some examples are MIN, AVG, and SUM.
dimensions: Filter by the dimensions. This describes which field is used as the dimension when grouping data to calculate the aggregate analytic. Some examples are PRINCIPAL_DEVICE, PRINCIPAL_FILE_HASH, and EVENT_TYPE.
eventType: Filter by event type. This gives us details about the event type, which may be important if this analytic was computed over grouped data.
HTTP request
Path parameters
Parameters
parent
string
Required. The parent, which owns this collection of AnalyticValues. Format: projects/{project}/locations/{location}/instances/{instance}/analytics/{analytic}/entities/{entity
Query parameters
Parameters
pageSize
integer
Optional. The maximum number of entity analytic values to return. The service may return fewer than this value.
pageToken
string
Optional. A page token, received from a previous analyticValues.list call. Provide this to retrieve the subsequent page.
filter
string
Optional. Filter to be applied over multiple AnalyticValue fields. Please see API definition for usage.
orderBy
string
Optional. Configures ordering of AnalyticValues in the response.
Request body
The request body must be empty.
Response body
Response message for analyticValues.list.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis API endpoint, \u003ccode\u003eprojects.locations.instances.analytics.entities.analyticValues.list\u003c/code\u003e, retrieves a list of analytic values, which are data points (numeric value and interval) for a specific entity and analytic, filtering them by timestamps, aggregate function, dimensions, and event type.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request to list these values is a \u003ccode\u003eGET\u003c/code\u003e request to \u003ccode\u003ehttps://chronicle.googleapis.com/v1alpha/{parent}/analyticValues\u003c/code\u003e, and requires specifying the \u003ccode\u003eparent\u003c/code\u003e path parameter in the format "projects/{project}/locations/{location}/instances/{instance}/analytics/{analytic}/entities/{entity}".\u003c/p\u003e\n"],["\u003cp\u003eQuery parameters such as \u003ccode\u003epageSize\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e are optional and allow for pagination, filtering, and ordering of the analytic values returned.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003eAnalyticValue\u003c/code\u003e objects, each representing a data point with fields such as \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003evalue\u003c/code\u003e, \u003ccode\u003einterval\u003c/code\u003e, \u003ccode\u003eevent_count\u003c/code\u003e, \u003ccode\u003eaggregate_function\u003c/code\u003e, \u003ccode\u003edimensions\u003c/code\u003e, \u003ccode\u003eevent_type\u003c/code\u003e, and \u003ccode\u003elabel\u003c/code\u003e, along with a \u003ccode\u003enext_page_token\u003c/code\u003e for paginated results.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this API requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e and the IAM permission \u003ccode\u003echronicle.analyticValues.list\u003c/code\u003e on the \u003ccode\u003eparent\u003c/code\u003e resource.\u003c/p\u003e\n"]]],[],null,["# Method: analyticValues.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAnalyticValuesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [AnalyticValue](#AnalyticValue)\n - [JSON representation](#AnalyticValue.SCHEMA_REPRESENTATION)\n- [Try it!](#try-it)\n\n**Full name**: projects.locations.instances.analytics.entities.analyticValues.list\n\nLists analytic values. An analytic value refers to a data point (numeric value \\& interval) for a specific entity and analytic. The API returns matching AnalyticValues for the desired entity and analytic, according to the following filters:\n\n*Timestamps use RFC 3339. Read more [here](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)*\n\n- **lookback_interval**: Filter by the lookback interval, up to 90 days. Example:\n\n`\nlookback_interval.start_time greater than or equal to\n\"2023-08-10T14:20:59.950218416Z\" AND lookback_interval.end_time less\nthan or equal to \"2023-08-17T14:20:59.950219626Z\"\n`\n\n- **aggregateFunction**: Filter by the aggregate function. This represents the mathematical function used to calculate the analytic value. Some examples are MIN, AVG, and SUM.\n\n- **dimensions**: Filter by the dimensions. This describes which field is used as the dimension when grouping data to calculate the aggregate analytic. Some examples are PRINCIPAL_DEVICE, PRINCIPAL_FILE_HASH, and EVENT_TYPE.\n\n- **eventType**: Filter by event type. This gives us details about the event type, which may be important if this analytic was computed over grouped data.\n\n### HTTP request\n\nChoose a location: \nafrica-south1 asia-northeast1 asia-south1 asia-southeast1 asia-southeast2 australia-southeast1 europe-west12 europe-west2 europe-west3 europe-west6 europe-west9 me-central1 me-central2 me-west1 northamerica-northeast2 southamerica-east1 us eu \n\n\u003cbr /\u003e\n\n### Path parameters\n\n### Query parameters\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for analyticValues.list.\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `parent` resource:\n\n- `chronicle.analyticValues.list`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nAnalyticValue\n-------------\n\nAn AnalyticValue represents a data point for an analytic which is exhibited by an entity at a given time interval."]]
