Article Search Response

The results of an Article search

typestring

The type of the object - list.

Value:"list"

Example:"list"

total_countinteger

The total number of Articles matching the search query

Example:5

dataobject

An object containing the results of the search. When no articles match, this is an empty array instead.

pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "list",
  "total_count": 5,
  "data": {
    "articles": [ … ],
    "highlights": [ … ]
  },
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "prev": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}