Pagination

When querying a Constellation (e.g. listing nodes), the system will sometimes utilize depth, skip, and count parameters to determine what items to collect.

• Depth is the maximum depth that will be searched before returning the collected items regardless of count and skip.
  • Passing -1 or null (missing) means that the entire collection will be searched.
• Skip is the amount of items to skip before starting to collect.
  • Passing 0 or null (missing) means that no items will be skipped.
• Count is the amount of items to collect before returning the collected items.
  • Passing -1 or null (missing) means that all items will be collected unless stopped by depth first.

The following depth, skip, and count combination on a collection of items [A, B, C, D, E, F, G, H, I, J, K] would yield items [D, E, F]:

      ↓ Skip (3)
A B C [ D E F | G H ] I J K
    Depth (6) ↑     ↑ Count (5)

Note

Some endpoints in konstellat.io may only allow certain depth, skip, and count range values and will return a 400 Bad Request if one of said parameters has a value outside their allowed range.