Observations

List Observations

Changed on

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

Request

  • Base URL
    https://memory.twilio.com
  • URL
    https://memory.twilio.com/v1/Stores/{storeId}/Profiles/{profileId}/Observations
  • Auth
    HTTP basic

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, periods, underscores, hyphens, and forward slashes.

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).

conversationIdstring

A unique identifier for the conversation using Twilio Type ID (TTID) format.

Example:conv_conversation_00000000000000000000000000

Filter by conversation ID. Returns only items associated with the specified conversation.

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"
  }
}

Changes

    • warning

      changed the pattern of the query request parameter source from ^[a-zA-Z0-9 _.-]+$ to ^[a-zA-Z0-9 _./-]+$

    • info

      the // response's property pattern was changed from ^[a-zA-Z0-9 _.-]+$ to ^[a-zA-Z0-9 _./-]+$ for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property // became optional for the status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • breaking

      the response property's max was increased from 99999.00 to 999999.00 for the response status

    • info

      added the new optional query request parameter conversationId

    • info

      for the query request parameter pageToken, the maxLength was increased from 500 to 4096