v3

latestOpenAPI 3.0.1Apache 2.0raw.githubusercontent.com2026-08-014669239.7 KB
Observations

List Observations

Retrieve a paginated list of transient observations for a specific profile. Observations are sorted by creation time in descending order by default. Results can be filtered by source parameter. Supports response compression for large datasets.

get/v1/Stores/{storeId}/Profiles/{profileId}/Observations

Query parameters

pageSizeinteger

The maximum number of items to return per page, maximum of 1000.

pageTokenstring

The token for the page of results to retrieve.

orderBy'ASC' | 'DESC'

Either 'ASC' or 'DESC' to sort results ascending or descending respectively.

sourcestring
Example:customer service platform

Filter by source. Allows letters, numbers, spaces, and URL-safe symbols. Excludes URL-unsafe characters like quotes, angle brackets, and control characters.

createdAfterstring date-time
Example:2025-01-01T00:00:00Z

Filter observations created after this timestamp (inclusive).

createdBeforestring date-time
Example:2025-01-31T23:59:59Z

Filter observations created before this timestamp (exclusive).

Headers

Accept-Encodingstring
Example:gzip, deflate, br

Compression algorithms supported by the client (e.g., gzip, deflate, br)

Response

A list of observations for the profile.

Example response

{
  "observations": [
    {
      "content": "Customer expressed satisfaction with recent product update during support call.",
      "occurredAt": "2025-01-15T10:15:30Z",
      "source": "conversational-intelligence",
      "conversationIds": [
        "conv_conversation_00000000000000000000000000"
      ],
      "id": "mem_observation_00000000000000000000000000",
      "createdAt": "2025-01-15T10:30:45Z",
      "updatedAt": "2025-01-15T10:30:45Z"
    }
  ],
  "meta": {
    "key": "observations",
    "nextToken": "eyJlYXN0ZXIiOiJlZ2cifQ",
    "previousToken": "eyJlYXN0ZXIiOiJlZ2cifQ"
  }
}