Para optimizar el procesamiento y el tráfico de red, los datos que devuelven todos los servicios de la API se paginan en grupos de hasta 1,000 registros como máximo. Si el parámetro limit no se define en el request, se utiliza el valor 100 por defecto. Si el parámetro limit tiene un valor mayor a 1,000, se ignora la solicitud y el paginado queda limitado a 1,000 registros.
Todas las respuestas de la API incluyen un objeto denominado meta que contiene:
- La cantidad total de registros a devolver
- El
offseto cantidad de registros a omitir desde el inicio del cursor - El límite de registros de cada página
Supongamos que el total de registros de un endpoint es de 4,116 registros y solicitamos su paginación en grupos de 50 registros. La API devolverá el siguiente objeto meta en el json de respuesta:
"meta": {
"total": 4116,
"offset": 0,
"limit": 50
}
Para obtener la segunda página - es decir, los registros 51 a 100, se deberá establecer el parámetro offset en el request con el valor 50, pues se desea omitir los primeros 50 registros.
Si se establece un valor de offset mayor a la cantidad de registros totales, la API devuelve un conjunto de registros vacíos. Por último, los parámetros limit y offset son independientes entre cada llamado y por lo tanto, pueden ser modificados entre un request y el siguiente.