V2 Search
Model Webhook
Pagination
- class PaginationMetadata(server_response)
Pagination metadata.
- Parameters:
server_response (dict)
- page: int
1-indexed page number.
- per_page: int
Number of results per page.
- total_items: int
Total number of items.
- total_items_unfiltered: int | None
Total number of items, including unfiltered results.
- total_pages: int
Total number of pages.
Search Model
Search Models
- class SearchModels(raw_response)
List of models.
- Parameters:
raw_response (list[dict])
- append(object, /)
Append object to the end of the list.
- clear()
Remove all items from list.
- copy()
Return a shallow copy of the list.
- count(value, /)
Return number of occurrences of value.
- extend(iterable, /)
Extend list by appending elements from the iterable.
- index(value, start=0, stop=9223372036854775807, /)
Return first index of value.
Raises ValueError if the value is not present.
- insert(index, object, /)
Insert object before index.
- pop(index=-1, /)
Remove and return item at index (default last).
Raises IndexError if list is empty or index is out of range.
- remove(value, /)
Remove first occurrence of value.
Raises ValueError if the value is not present.
- reverse()
Reverse IN PLACE.
- sort(*, key=None, reverse=False)
Sort the list in ascending order and return None.
The sort is in-place (i.e. the list itself is modified) and stable (i.e. the order of two equal elements is maintained).
If a key function is given, apply it once to each list item and sort them, ascending or descending, according to their function values.
The reverse flag can be set to sort in descending order.
Search Response
- class SearchResponse(raw_response)
Models search response.
- Parameters:
raw_response (dict[str, Any])
- models: SearchModels
Parsed search payload.
- pagination: PaginationMetadata
Pagination metadata for the search results.
- property raw_http: str
Displays the result of the raw response as json string.