Image Artist: Handling Paginated Search Results

When using the Image Artist Search API, the total number of matching results may exceed the maximum number of items that can be returned in a single response.

 

For example:

 

{
  "count": 1073,
  "items_per_page": 50
}

 

Where:

• count is the total number of records matching the search criteria.
• items_per_page is the maximum number of records returned in a single response.

Note: The items_per_page value is currently fixed at 50 and cannot be modified through the API.

 

 

Pagination Links

When the result set spans multiple pages, the response includes pagination links that can be used to retrieve additional pages of results.

 

Example:

 

{
  "first": {
    "href": "/api/1.1/search/"
  },
  "next": {
    "href": "/api/1.1/search/?page=2"
  },
  "last": {
    "href": "/api/1.1/search/?page=22"
  }
}

 

In this example:

• Results are distributed across 22 pages.
• The next link can be used to retrieve the next page of results.
• The last link identifies the final page in the result set.

 

Requesting Additional Pages

To retrieve subsequent pages, issue a request to the URL specified by the pagination link.

For example, to retrieve page 2:

curl --insecure --location --request GET \
  "https://ima-server.com/api/1.1/search/?page=2" \
  --header "PKI-Columbus-Authentication: <TOKEN>" \
  --header "Content-Type: application/json"

Where:

• <TOKEN> is a valid authentication token obtained from the authentication endpoint.

  Refer to:  Image Artist: Retrieving an Authentication Token from the Public API

 

Retrieving All Results

Applications that need to process the complete result set should follow the pagination links provided in the response and continue requesting pages until no further next link is returned.

This approach ensures that all matching records are retrieved, regardless of the total number of search results.