For the complete documentation index, see llms.txt. This page is also available as Markdown.

Personalization API reference

Endpoint, authentication, and responses for the DinMo Personalization API.

Base URL

https://data-export-api.dinmo.io/v1

Retrieve a record

Use the endpoint displayed on an exposure. Its URL follows this format:

GET /models/{workspace_id}/{model_id}/records/{record_id}
Parameter
Description

workspace_id

The workspace identifier included in the exposure endpoint.

model_id

The model identifier included in the exposure endpoint.

record_id

A value for the lookup key configured in the activation.

Authentication

Send a Personalization API key in the Authorization header.

Authorization: Bearer <API_KEY>

Request example

curl --request GET \
  --url 'https://data-export-api.dinmo.io/v1/models/<workspace_id>/<model_id>/records/<record_id>' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer <API_KEY>'

Response

The response contains the lookup key and the attributes mapped in the activation. The exact schema depends on the exposure configuration.

Response codes

Status
Meaning
Recommended action

200

The record was found.

Use the response.

401

The API key is missing or invalid.

Check the Authorization header and key status.

404

No record matches the lookup-key value.

Use your application fallback.

429

The request rate limit was exceeded.

Retry with backoff and reduce request volume.

5xx

A temporary service error occurred.

Retry with exponential backoff and use a fallback when appropriate.

Integration guidance

Keep API calls on trusted server-side infrastructure or an edge function. Cache only when your use case permits it, and use a fallback response so your customer experience remains available when a record is missing or the service is temporarily unavailable.

Last updated