--- title: "POST /v1/user/metrics/query" method: POST path: "/v1/user/metrics/query" tags: ["User"] --- # POST /v1/user/metrics/query `POST /v1/user/metrics/query` ## Request body - UserMetricsQueryParams - `filter` union, required - FilterLeafSubsetUsersViewOrRequestResponseRmt — From T, pick a set of properties whose keys are in the union K - `request_response_rmt` PartialRequestResponseRMTToOperators — Make all properties in T optional - `country_code` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `latency` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `cost` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `provider` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `time_to_first_token` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `status` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `request_created_at` PartialTimestampOperatorsTyped — Make all properties in T optional - `equals` string, date-time - `gte` string, date-time - `lte` string, date-time - `lt` string, date-time - `gt` string, date-time - `response_created_at` PartialTimestampOperatorsTyped — Make all properties in T optional - `equals` string, date-time - `gte` string, date-time - `lte` string, date-time - `lt` string, date-time - `gt` string, date-time - `model` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `user_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `organization_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `node_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `job_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `threat` PartialBooleanOperators — Make all properties in T optional - `equals` boolean - `request_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `prompt_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `completion_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `prompt_cache_read_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `prompt_cache_write_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `total_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `target_url` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `property_key` object - `equals` string, required - `properties` object - `search_properties` object - `scores` object - `scores_column` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `request_body` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `response_body` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `cache_enabled` PartialBooleanOperators — Make all properties in T optional - `equals` boolean - `cache_reference_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `cached` PartialBooleanOperators — Make all properties in T optional - `equals` boolean - `assets` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `helicone-score-feedback` PartialBooleanOperators — Make all properties in T optional - `equals` boolean - `prompt_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `prompt_version` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `request_referrer` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `is_passthrough_billing` PartialBooleanOperators — Make all properties in T optional - `equals` boolean - `users_view` PartialUserViewToOperators — Make all properties in T optional - `user_user_id` PartialTextOperators — Make all properties in T optional - `not-equals` string - `equals` string - `like` string - `ilike` string - `contains` string - `not-contains` string - `user_active_for` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_first_active` PartialTimestampOperatorsTyped — Make all properties in T optional - `equals` string, date-time - `gte` string, date-time - `lte` string, date-time - `lt` string, date-time - `gt` string, date-time - `user_last_active` PartialTimestampOperatorsTyped — Make all properties in T optional - `equals` string, date-time - `gte` string, date-time - `lte` string, date-time - `lt` string, date-time - `gt` string, date-time - `user_total_requests` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_average_requests_per_day_active` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_average_tokens_per_request` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_total_completion_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_total_prompt_tokens` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - `user_cost` PartialNumberOperators — Make all properties in T optional - `not-equals` number, double - `equals` number, double - `gte` number, double - `lte` number, double - `lt` number, double - `gt` number, double - UserFilterBranch - `right` UserFilterNode, required — recursive - `operator` 'or' | 'and', required - `left` UserFilterNode, required — recursive - 'all' - `offset` number, double, required - `limit` number, double, required - `timeFilter` object - `endTimeUnixSeconds` number, double, required - `startTimeUnixSeconds` number, double, required - `timeZoneDifferenceMinutes` number, double - `sort` SortLeafUsers - `id` 'asc' | 'desc' - `user_id` 'asc' | 'desc' - `active_for` 'asc' | 'desc' - `first_active` 'asc' | 'desc' - `last_active` 'asc' | 'desc' - `total_requests` 'asc' | 'desc' - `average_requests_per_day_active` 'asc' | 'desc' - `average_tokens_per_request` 'asc' | 'desc' - `total_prompt_tokens` 'asc' | 'desc' - `total_completion_tokens` 'asc' | 'desc' - `cost` 'asc' | 'desc' - `rate_limited_count` 'asc' | 'desc' ## Response `200` Ok - union - ResultSuccessUsersUserMetricsResultArrayCountNumberHasUsersBoolean - `data` object, required - `hasUsers` boolean, required - `count` number, double, required - `users` UserMetricsResult[], required - `id` string, required - `user_id` string, required - `active_for` number, double, required - `first_active` string, required - `last_active` string, required - `total_requests` number, double, required - `average_requests_per_day_active` number, double, required - `average_tokens_per_request` number, double, required - `total_completion_tokens` number, double, required - `total_prompt_tokens` number, double, required - `cost` number, double, required - `error` null, nullable, required - ResultErrorString - `data` null, nullable, required - `error` string, required --- [API](https://skmtc.net/helicone/apis/helicone-api.md) · [All operations](https://skmtc.net/helicone/apis/helicone-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helicone/helicone-api/revisions/b369e9e3e80c/schema)