v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Get pages modified between two dates.

Returns the page metadata for pages modified between the specified last modified date range in the site specified by site-id. <br />User roles: admin, manager, editor, viewer

get/authoring/v1/sites/{site-id}/pages/views/by-modified

Path parameters

site-idstring uuid required

The ID of the site.

Query parameters

startstring date-time

Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or after this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

endstring date-time

Provide the date and time of when the last modifications were made to the page items that you want returned. The page items that are modified on or before this date and time are returned. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

fieldsstring

Reduce the returned page metadata down to just the specified fields in the returned page hierarchy. Fields specified by a comma seperated list of field names and should only be used once in query string. To only retrieve rev and lastModified this parameter should look like fields=rev,lastModified.

orderstring

Specify whether you want the page items to be returned in ascending or descending order. Documents are returned in ascending order by default. Supported order values are 'asc', 'ascending', 'desc' and 'descending' e.g. /sites/dummySitesId/pages/views/by-modified?order=descending returns the pages in descending order.

limitnumber

Set the limit for the maximum number of items to return in a single result. The default value is 50. Use 0 for unlimited. If offset and limit are not set, all results are returned.

offsetnumber

Use the offset parameter to specify the number of items to skip from the beginning of the list and return the rest. The default value is 0. If offset and limit are not set, all results are returned.

includestring

Specify additional fields to include with each result. The following fields can be specified to be included in the page item: 'hierarchicalPath', 'route'. You can specify multiple fields as a comma-separated value. For example, include=hierarchicalPath,route. The hierarchicalPath field is a concatenation of each ancestor page name field and the route field is a concatenation of each ancestor page segment field.

Response

succcess.