List favorites
Returns the favorite marks of the current user, newest first.
Request
POST
https://api.datalens.tech/rpc/listFavorites
Headers
|
Name |
Description |
|
x-dl-api-version |
Type: string API version header. Const: Example: |
Body
application/json
{
"entityTypes": [
"entry"
],
"pageSize": 1,
"pageToken": "example"
}
|
Name |
Description |
|
entityTypes |
Type: string[] Entity types to return. All types are returned if the field is omitted. Min items: Example |
|
pageSize |
Type: integer Maximum number of favorites per page. Defaults to 200. Min value: Max value: |
|
pageToken |
Type: string Token of the page to return, taken from the previous response. Example: |
Responses
200 OK
Response
Body
application/json
{
"entities": [
{
"entityId": "example",
"entityType": "entry",
"displayAlias": "example",
"createdAt": "example"
}
],
"nextPageToken": "example"
}
|
Name |
Description |
|
entities |
Type: FavoriteMark[] Favorite marks of the current user. Example |
|
nextPageToken |
Type: string Token of the next page. Absent on the last page. Example: |
FavoriteMark
|
Name |
Description |
|
createdAt |
Type: string Date and time when the entity was marked as a favorite. Example: |
|
displayAlias |
Type: string | null Custom name the user gave to the favorite, or null if there is none. Example: |
|
entityId |
Type: string ID of the entity marked as a favorite. Example: |
|
entityType |
Type: string Type of the entity marked as a favorite. Enum: |
Example
{
"entityId": "example",
"entityType": "entry",
"displayAlias": "example",
"createdAt": "example"
}