Fourth, Detailed Explanation of Request Parameters

4.1 General Parameter Format

The API interface supports two ways of parameter transmission:

  • Query ParametersPassed through the URL query string, applicable for GET requests
  • Body parametersPassed through the request body, applicable for POST requests

4.2 Pagination Parameter Description

Most list interfaces support pagination, and common pagination parameters include:

Parameter name Type Description
page integer Page number, default is 1, used by some interfacescurrentAs the current page number, please refer to the actual interface
limit integer Number of items per page, default is 10, used in some interfacespaegSizeAs the number of items per page, please refer to the actual interface
offset integer Offset, used for more flexible pagination, some interfaces do not support it, please refer to the actual interface.

4.3 Sorting Parameter Description

Sorting parameters are used to control the order of the returned data:

Parameter name Type Description
order string Sort method, such asid desc/created_time asc

4.4 Parameter Description

The filter parameters are used to filter data:

Parameter name Type Description
q string Search keywords
type string List type filtering, type=“list” does not include pagination, type=“page” includes pagination
flag string Recommended attribute filtering, supported flag values include: Top News [h], Recommended [c], Carousel [f], Special Recommendation [a], Scrolling [s], Bold [h], Image [p], Redirect [j]