Returning.AIDevelopers
v1

API reference / Gamification / Rolling Data

.md

Get daily calculation data

List the daily values of your calculated user fields, one row per trader per day.

Last updated 26 Sep 2026API v1

Method
GET
Path
https://api.returning.ai/v1/custom-field-values/daily
Permission
userFields
Retries
Don't retry the 404

When to use this

  • You chart how a calculated field, such as daily trading volume, changed for each trader day by day.
  • You copy daily values into your own reporting.

Authentication#

Header
Authorization: Bearer <API_KEY>
Permission
userFieldsShown in the dashboard as “User Fields”

As built, the endpoint takes a Community API key with userFields, shown in the dashboard as User Fields, and the key decides the community. On the public API today, every request gets 404 before the key is checked.

Behaviour#

This endpoint is not available on the public API: https://api.returning.ai/v1/custom-field-values/daily returns 404 with an empty body for every request. The parameters and the response on this page describe the endpoint as built, and haven't been confirmed on the public API.

Each row is one trader's value of one calculated user field for one day. Rows are read-only here.

Request#

Query parameters#

fieldId#stringOPTIONAL
Only rows for this user field ID.

Rule24-character hex ID

field_name#stringOPTIONAL
Only rows for this user field key, matched exactly.

RuleField key

Egtradingvolume

userId#numberOPTIONAL
Only rows for this trader, by platform user ID.

RuleWhole number

Eg3247779

sortBy#stringOPTIONAL
What to sort by.

RulevalueDate (default), createdAt, updatedAt or userId

EgvalueDate

sortOrder#stringOPTIONAL
Sort direction.

Ruledesc (default) or asc

Egdesc

page#stringOPTIONAL
Page number, starting at 1.

RuleWhole number, 1 or more; default 1

Eg1

limit#stringOPTIONAL
Rows per page.

RuleDefault 50; max 200

Eg50

Headers#

Authorization#stringREQUIRED
Community API key with userFields.

RuleBearer <API_KEY>

curl --request GET \
  --url 'https://api.returning.ai/v1/custom-field-values/daily?field_name=tradingvolume&limit=50' \
  --header 'Authorization: Bearer <API_KEY>'

Response#

When the path is available, a 200 returns the page in data.data and the totals in data.pagination. Today, expect 404.

status#stringALWAYS
Result of the request.

Rulesuccess

message#stringALWAYS
Human-readable summary. Do not branch on it.
data#objectALWAYS
The page of rows and the paging totals.
data#object[]ALWAYS
Rows on this page. Empty when nothing matches.
_id#string
The row's ID.
communityId#string
Your community ID.
userId#number
The trader's platform user ID.
email#string
The trader's email, or null when none is stored.
field_name#string
The user field's key.
valueDate#string
The day the value belongs to, ISO 8601.
value#number
The field's value for that day.
createdAt#string
When the row was first written, ISO 8601 UTC.
updatedAt#string
When the row last changed, ISO 8601 UTC.
pagination#objectALWAYS
Paging totals: total, page, limit and totalPages.
{
  "status": "success",
  "message": "Daily custom field values fetched successfully",
  "data": {
    "data": [
      {
        "_id": "66f000000000000000000730",
        "communityId": "66f000000000000000000010",
        "userId": 3247779,
        "email": "trader@example.com",
        "field_name": "tradingvolume",
        "valueDate": "2026-09-26T00:00:00.000Z",
        "value": 125000.5,
        "createdAt": "2026-09-27T00:05:00.000Z",
        "updatedAt": "2026-09-27T00:05:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 50,
      "totalPages": 1
    }
  }
}

Errors#

The only response from the public API today is 404 with an empty body.

Do not retry01

404Do not retry
The public API doesn't serve this path yet, so every request returns 404 with an empty body, whatever the key or parameters. Don't retry. Read stored field values with Get a trader's field history instead.
{
  "status": "success",
  "message": "Daily custom field values fetched successfully",
  "data": {
    "data": [
      {
        "_id": "66f000000000000000000730",
        "communityId": "66f000000000000000000010",
        "userId": 3247779,
        "email": "trader@example.com",
        "field_name": "tradingvolume",
        "valueDate": "2026-09-26T00:00:00.000Z",
        "value": 125000.5,
        "createdAt": "2026-09-27T00:05:00.000Z",
        "updatedAt": "2026-09-27T00:05:00.000Z"
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 50,
      "totalPages": 1
    }
  }
}

Next step#

Get a trader's field historyGET/v1/communities/{communityId}/users/{userId}/user-fields/{fieldIdOrName}/historiesRead the stored values of a user field for one trader.