Search user gamification logs
POST
/v1/gamifications/logs
What this endpoint does
INFO
POST /v1/gamifications/logs with user → page through data.data.Quick start
date { gte, lte }, time { gte, lte }, and action as an array of action names./v1/gamifications/logs (plural gamifications).Authentication and permission
External client identifier
hashed_client_id is an optional string on each row in data.data. It contains the existing external identifier from the community's active custom client_id single-line-text field. Returning.AI does not compute a new hash and does not relabel another custom identifier field.hashed_client_id is omitted rather than returned as null or an empty string. Treat the value as an opaque identifier; do not assume a particular hash algorithm, length, or format.client_id as the internal Returning.AI member ID represented as a string. User logs retain their existing fields and do not introduce an internal client_id where none was previously present.Complete examples
{ status: "success", data: { pagination, data } }. Empty data.data with pagination.total: 0 means no events matched.Get gamification logs endpoint validation error. detail.user: Required.Success and readback
200. Repeat with a different page or action filter. This POST is a read.Errors and recovery
| Status | When | Recovery |
|---|---|---|
400 user required | Empty body | Send user as the member email. |
401 | Missing or invalid token | Add a valid community key. |
Retry safety
TIP
Gotchas
/v1/gamifications/logs, not /v1/gamification/logs.data is not a missing member. Confirm the email with POST /v1/users/info.Next steps
Request
Header Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location 'https://atfx-integration.returning.ai/apis/v1/gamifications/logs' \
--header 'Authorization: Bearer <COMMUNITY_API_KEY>' \
--header 'Content-Type: application/json' \
--data-raw '{
"user": "client@example.com",
"limit": 100,
"page": 1
}'Response Response Example
200 - Populated page
{
"status": "success",
"data": {
"pagination": {
"total": 3,
"currentPage": 1,
"totalPages": 1,
"hasNextPage": false,
"hasPrevPage": false
},
"data": [
{
"_id": "66c2f2a7b83b0b1234567890",
"email": "client@example.com",
"action": "Send message",
"action_details": "Posted a message in a community channel",
"xp": 20,
"currency": 5,
"date": "2026-08-17",
"time": "09:30",
"hashed_client_id": "external-client-hash"
}
]
}
}Modified at 2026-10-07 12:15:28