---
title: "List ProfileSample"
method: POST
path: "/profile-sample/get-list"
tags: ["ProfileSample"]
---

# List ProfileSample

`POST /profile-sample/get-list`

## Request

- Base URL: `https://oneuptime.com/api`
- URL: `https://oneuptime.com/api/profile-sample/get-list`
- Auth: API key in header `APIKey`
- TypeScript: <https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/docs/profile-sample/get-list/post.ts> (a function with typed inputs; its response is checked against the schema)

Endpoint to list all ProfileSample items

## Request body

- object
  - `query` ProfileSampleItemV3QuerySchema: Query schema for ProfileSampleItemV3. A field takes a plain value, which it matches exactly, or an operator its type allows. Telemetry tables are large: bound every query by time.
    - `projectId` union: Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `primaryEntityId` union: Query operators for primaryEntityId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `primaryEntityType` union: Query operators for primaryEntityType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `profileId` union: Query operators for profileId field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `traceId` union: Query operators for traceId field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `spanId` union: Query operators for spanId field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `time` union: Query operators for time field of type DateTime64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
    - `timeUnixNano` union: Query operators for timeUnixNano field of type UInt64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. A value past 2^53 is sent as a string of digits.
      - number
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'InBetween', required
        - `startValue` union, required
          - number
          - string
        - `endValue` union, required
          - number
          - string
    - `stacktrace` union: Query operators for stacktrace field of type Array of Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, Search. EqualTo, NotEqual and Search match one element; Includes matches any of several.
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `stacktraceHash` union: Query operators for stacktraceHash field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `frameTypes` union: Query operators for frameTypes field of type Array of Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, Search. EqualTo, NotEqual and Search match one element; Includes matches any of several.
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `value` union: Query operators for value field of type UInt64. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. A value past 2^53 is sent as a string of digits.
      - number
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThan', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` union, required
          - number
          - string
      - object
        - `_type` 'InBetween', required
        - `startValue` union, required
          - number
          - string
        - `endValue` union, required
          - number
          - string
    - `profileType` union: Query operators for profileType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `labels` object: Query operators for labels field of type Map(String, String). Supported operators: EqualTo, NotEqual, IsNull, NotNull, Search. Filtered by key, each key with these operators: {"labels": {"<key>": <value or operator>}}.
    - `entityKeys` union: Query operators for entityKeys field of type Array of Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, Search. EqualTo, NotEqual and Search match one element; Includes matches any of several.
      - object
        - `_type` 'EqualTo', required
        - `value` string, required
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `serviceEntityKey` union: Query operators for serviceEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `hostEntityKey` union: Query operators for hostEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `k8sPodEntityKey` union: Query operators for k8sPodEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `k8sNodeEntityKey` union: Query operators for k8sNodeEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `k8sClusterEntityKey` union: Query operators for k8sClusterEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `containerEntityKey` union: Query operators for containerEntityKey field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
      - object
        - `_type` 'EqualToOrNull', required
        - `value` string, required
      - object
        - `_type` 'Search', required
        - `value` string, required
    - `_id` union: Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes.
      - string
      - object
        - `_type` 'NotEqual', required
        - `value` string, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'Includes', required
        - `value` string[], required
    - `createdAt` union: Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z.
      - string, date-time
      - object
        - `_type` 'NotEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'IsNull', required
      - object
        - `_type` 'NotNull', required
      - object
        - `_type` 'GreaterThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'GreaterThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThan', required
        - `value` string, date-time, required
      - object
        - `_type` 'LessThanOrEqual', required
        - `value` string, date-time, required
      - object
        - `_type` 'InBetween', required
        - `startValue` string, date-time, required
        - `endValue` string, date-time, required
  - `select` ProfileSampleItemV3SelectSchema: Select schema for ProfileSampleItemV3. Set fields to true to include them in the response.
    - `projectId` boolean
    - `primaryEntityId` boolean
    - `primaryEntityType` boolean
    - `profileId` boolean
    - `traceId` boolean
    - `spanId` boolean
    - `time` boolean
    - `timeUnixNano` boolean
    - `stacktrace` boolean
    - `stacktraceHash` boolean
    - `frameTypes` boolean
    - `value` boolean
    - `profileType` boolean
    - `labels` boolean
    - `entityKeys` boolean
    - `serviceEntityKey` boolean
    - `hostEntityKey` boolean
    - `k8sPodEntityKey` boolean
    - `k8sNodeEntityKey` boolean
    - `k8sClusterEntityKey` boolean
    - `containerEntityKey` boolean
    - `_id` boolean
    - `createdAt` boolean
  - `sort` ProfileSampleItemV3SortSchema: Sort schema for ProfileSampleItemV3. Only sortable fields are included.
    - `projectId` 'ASC' | 'DESC': Sort order for projectId field
    - `primaryEntityId` 'ASC' | 'DESC': Sort order for primaryEntityId field
    - `primaryEntityType` 'ASC' | 'DESC': Sort order for primaryEntityType field
    - `profileId` 'ASC' | 'DESC': Sort order for profileId field
    - `traceId` 'ASC' | 'DESC': Sort order for traceId field
    - `spanId` 'ASC' | 'DESC': Sort order for spanId field
    - `time` 'ASC' | 'DESC': Sort order for time field
    - `timeUnixNano` 'ASC' | 'DESC': Sort order for timeUnixNano field
    - `stacktraceHash` 'ASC' | 'DESC': Sort order for stacktraceHash field
    - `value` 'ASC' | 'DESC': Sort order for value field
    - `profileType` 'ASC' | 'DESC': Sort order for profileType field
    - `serviceEntityKey` 'ASC' | 'DESC': Sort order for serviceEntityKey field
    - `hostEntityKey` 'ASC' | 'DESC': Sort order for hostEntityKey field
    - `k8sPodEntityKey` 'ASC' | 'DESC': Sort order for k8sPodEntityKey field
    - `k8sNodeEntityKey` 'ASC' | 'DESC': Sort order for k8sNodeEntityKey field
    - `k8sClusterEntityKey` 'ASC' | 'DESC': Sort order for k8sClusterEntityKey field
    - `containerEntityKey` 'ASC' | 'DESC': Sort order for containerEntityKey field
    - `retentionDate` 'ASC' | 'DESC': Sort order for retentionDate field
    - `_id` 'ASC' | 'DESC': Sort order for _id field
    - `createdAt` 'ASC' | 'DESC': Sort order for createdAt field
  - `groupBy` ProfileSampleItemV3GroupBySchema: Group by schema for ProfileSampleItemV3. Only one field can be set to true for grouping.
    - `projectId` boolean: Group by projectId field. Only one field can be selected for grouping.
    - `primaryEntityId` boolean: Group by primaryEntityId field. Only one field can be selected for grouping.
    - `primaryEntityType` boolean: Group by primaryEntityType field. Only one field can be selected for grouping.
    - `profileId` boolean: Group by profileId field. Only one field can be selected for grouping.
    - `traceId` boolean: Group by traceId field. Only one field can be selected for grouping.
    - `spanId` boolean: Group by spanId field. Only one field can be selected for grouping.
    - `stacktraceHash` boolean: Group by stacktraceHash field. Only one field can be selected for grouping.
    - `profileType` boolean: Group by profileType field. Only one field can be selected for grouping.
    - `serviceEntityKey` boolean: Group by serviceEntityKey field. Only one field can be selected for grouping.
    - `hostEntityKey` boolean: Group by hostEntityKey field. Only one field can be selected for grouping.
    - `k8sPodEntityKey` boolean: Group by k8sPodEntityKey field. Only one field can be selected for grouping.
    - `k8sNodeEntityKey` boolean: Group by k8sNodeEntityKey field. Only one field can be selected for grouping.
    - `k8sClusterEntityKey` boolean: Group by k8sClusterEntityKey field. Only one field can be selected for grouping.
    - `containerEntityKey` boolean: Group by containerEntityKey field. Only one field can be selected for grouping.
    - `_id` boolean: Group by _id field. Only one field can be selected for grouping.
    - `createdAt` boolean: Group by createdAt field. Only one field can be selected for grouping.
  - `limit` number: Maximum number of items to return. Defaults to 10.
  - `skip` number: Number of items to skip for pagination. Defaults to 0.

## Response `200`

Successful response

- object
  - `data` ProfileSampleItemV3[]
    - `projectId` string, required: Project ID
    - `primaryEntityId` string, required: Service ID
    - `primaryEntityType` string: Service Type
    - `profileId` string, required: Profile ID
    - `traceId` string: Trace ID
    - `spanId` string: Span ID
    - `time` string: Time
    - `timeUnixNano` string: Time (in Unix Nano)
    - `stacktrace` string[]: Stacktrace
    - `stacktraceHash` string, required: Stacktrace Hash
    - `frameTypes` string[]: Frame Types
    - `value` string: Value
    - `profileType` string, required: Profile Type
    - `labels` string: Labels
    - `entityKeys` string[]: Entity Keys
    - `serviceEntityKey` string: Service Entity Key
    - `hostEntityKey` string: Host Entity Key
    - `k8sPodEntityKey` string: Kubernetes Pod Entity Key
    - `k8sNodeEntityKey` string: Kubernetes Node Entity Key
    - `k8sClusterEntityKey` string: Kubernetes Cluster Entity Key
    - `containerEntityKey` string: Container Entity Key
  - `count` number

## Other responses

- `400`: Bad request. This response indicates that the request was malformed or contained invalid data.
- `401`: Unauthorized. This response indicates that the request requires user authentication.
- `402`: Payment Required. This response indicates that the request requires payment or a valid subscription.
- `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it.
- `405`: Project not found. This response indicates that the requested project does not exist or is not accessible.
- `408`: Request Timeout. This response indicates that the server timed out waiting for the request.
- `415`: Unable to reach server. This response indicates that the server is currently unreachable or down.
- `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource.
- `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

---

[API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)