The metadata object is included in every list response to provide useful information about the list.
This information is particularly helpful when working with large lists as it allows for easy pagination and navigation. Additionally, the metadata can be used to gain insights into the size and structure of the list, allowing for better performance optimization and analysis.
{
"total": 25,
"page": 1,
"limit": 10,
"pages": 3
}
| Attributes |
|---|
total Number: The total number of items in the list.page Number: The current page number.limit Number: The maximum number of items returned per page.pages Number: The total number of pages. |