Skip to main content

Retrieve a value by key

Retrieve a value by key from the specified entity namespace.

  • entity: Entity namespace (user or event)
  • key: Key identifier

Returns the stored value with metadata and sets appropriate response headers:

  • Content-Type: The content type of the stored value
  • X-KV-Created-At: When the key was created
  • X-KV-Updated-At: When the key was last updated
  • X-KV-Expires-At: When the key expires (if TTL was set)
  • Cache-Control: Caching directive based on TTL
Path Parameters
entity KVEntity REQUIRED

Possible values: [user, event]

Entity namespace types for KV storage

key Key REQUIRED
Responses
200

Successful Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

data object

Response data for get operation

entity KVEntity

Possible values: [user, event]

Entity namespace types for KV storage

key Key
value Value
content_type Content Type
metadata
created_at date-time
updated_at date-time
expires_at Expires At
size_bytes Size Bytes
default

Default Response

Schema OPTIONAL
ok Ok OPTIONAL

Indicates if the request was successful or not.

errors object[]

List of errors

type uri

Possible values: 1 ≤ length ≤ 2083

A string containing a URI reference that identifies the problem type.

status Status

Possible values: 399 < value < 600

A number indicating the HTTP status code.

title Title

Possible values: 5 ≤ length

A string containing a short, human-readable summary of the problem type.

detail Detail

Possible values: 5 ≤ length

A string containing a human-readable explanation specific to this occurrence of the problem.

instance Instance

Possible values: 1 ≤ length

A string containing a URI reference that identifies the specific occurrence of the problem.

error_code Error Code

A Number that indicates the error type that occurred.