This API allows you to ingest an event and receive a personalization response from Treasure Data's real-time system.
To successfully make the Real-time Personalization API call, you need to do the following things:
- Enable your account to access real-time services in the TD Console.
- Configure a database for Web Personalization with a detailed knowledge of the events and offers configured.
- A write-only API key
- A valid Web Personalization token.
The personalization API uses these Base URLs.
| Region | Base URL |
|---|---|
| US (us01) | https://us01.p13n.in.treasuredata.com |
| Europe (eu01) | https://eu01.p13n.in.treasuredata.com |
| Japan (ap01) | https://ap01.p13n.in.treasuredata.com |
The full URL for the personalization API is
{baseURL}/{database}/{table}
Here is an example:
https://us01.p13n.in.treasuredata.com/personalization__database/preferences_table
These are the required headers for the API call.
| Name | Content |
|---|---|
Content-Type | Vendor-specific JSON application vnd.treasuredata.v1+json |
WP13n-Token | Concatenated Token The token is created by combining the following elements: {account id}/{instance id}/{token} For example, for account ID 1, instance ID 8, and a valid Web Personalization token, the token would be formatted as follows |
Authorization | TD API Key
|
| HTTP Verb | Resource | Description |
|---|---|---|
| POST | /{database}/{tables} | Get offers for request |
[In progress: Pardon our dust]
204 Successful Ingestion
400 Bad Request
- 3000: RT token was not provided (X-Token header)
- 3001: RT token is not in the configuration
- 3002: RT token account conflicts with Authed user account
- 3003: RT token is in an invalid format
- 3004: Invalid event object.
429 Too Many Requests
- 2003: Kinesis error due to limit being exceeded
- 2013: Lambda total concurrent execution exceeds the reserved concurrency
500 Internal Server Error
- 9999: Unknown/undiagnosed
- 1001: TD API is unreachable or timed out
- 1002: Table API is unreachable or timed out
- 1003: Kinesis is unreachable or timed out
- 1004: Lambda is unreachable or timed out
- 1005: MemoryDB is unreachable or timed out
- 2001: Kinesis stream was not found
- 2002: Kinesis operation threw an error
- 2011: Lambda function was not found
- 2012: Lambda function threw an error, or the response was unhandled
- 2014: Lambda invocation failed
- 2015: Lambda reactor configuration doesn't have the token yet
- 2021: MemoryDB operation threw an error
- 3010: RT Token is configured with a reactor whose token is inconsistent (account or reactor ID)