Get custom log distinct values
GET/projects/{projectId}/entities/{entityId}/customLogs/{customLogDefinitionId}/valueList/{fieldName}
Base URL: https://api.tinkermode.com
Retrieves a list of distinct values for a given field in the entity's custom log.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user API key of a user with permission to read the entity custom log, a service account token with the same permission, or a project API key.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
entityId | string | Yes | Entity ID (unique within project) | |
customLogDefinitionId | string | Yes | Custom log definition ID (unique within entity class). | |
fieldName | string | Yes | The name of the field to find distinct values. |
Query parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
begin | string | Yes | The beginning time of the data entries. The format follows RFC3339. | |
end | string | Yes | The end time of the data entries. The format follows RFC3339. | |
fieldsFilter | string | No | A filter string starting with a conjunction. Supported conjunctions are AND() and OR().
A conjunction takes a comma-separated condition string like AND(group==="group_1",maxSpeed<5).
Each condition string defines a filter for the field value. The left-hand side must be a valid field name.
The right-hand side must be a value condition. For example, group==="group_1" matches any records that
the group field value exactly matches "group_1". Supported operators are following:
| Operator | |
| --- | --- |
| === | exact match |
| == | substring match |
| ~== | included in array as exact match. name~==["john"|"jeff"|"jack"] matches one of the three. |
| ~= | included in array as substring match. name~=["j"|"e"] matches "john", "jeff", "jack", and "ethan". |
| < | less than |
| <= | less than or equal to |
| > | greater than |
| >= | greater than or equal to |
|
Responses
200 Successfully retrieved distinct values.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
count | integer | Yes | The total number of unique values returned. | |
values | array<object> | Yes | An array containing the unique values found for the field. Values can be strings, numbers, or booleans. |
Response example
{
"count": 3,
"values": [
"error",
"warning",
"info"
]
}