The purpose of search APIs is to provide data on search queries. For example, you can search payments, checkout links, and payment links. You can use the search APIs to flexibly retrieve your Speed objects. Search is a faster alternative to paginating through all resources. Review the search query language to know more.
Speed's search API methods utilize cursor-based pagination via the page request parameter and next_page response parameter. For example, if you make a search request and receive next_page: pagination_key in the response, your subsequent call can include page=pagination_key to fetch the next page of results.
Search request format
{
"query":"amount<100",
"limit":7,
"page" : "63b2a79356c0e4ca36733212"
}
query string
The query clause according to Speed's query language. Make sure to check the list of query fields supported for the respective modules here.
limit integer
A limit specifies the number of objects to be returned. The default page size has 10 objects per page, and it is consistent across endpoints.
page integer
A cursor to scroll through the results pages. Enter the next_page value returned in a previous response in this parameter to request subsequent results. The first API call does not need this parameter.
Response
{
"has_more": true,
"object": "search_payment",
"data": [],
"next_page": null,
"total_count": 2
}
Attributes
has_more boolean
Whether or not there are more elements available after this set of records. If false, this set comprises the end of the list.
object string
The type of the object indicates to which entity this data array belongs.
data string
An array containing the actual record elements, paginated by request parameters.
next_page string
A cursor to scroll through the results pages. If has_more is true, you can pass the value of next_page to a subsequent call to fetch the next page of results.
total_count string
The total number of objects that match the query, only accurate up to 10,000.