Returns the URLs sitting directly in a site-census folder

Request

GET /v3/site-censuses/{censusId}/folders/urls

Lists the individual URLs whose containing folder is exactly folderPath (direct URLs only, not descendants), from site_census_urls, paginated.

Supply searchPattern to page through only the matching pages of one folder - the same pages the url-folders search nests in that folder's urls preview, using the identical page-name predicate and the same default (URL, id) order, so paging past a truncated preview continues the exact sequence the preview started and cannot surface pages the search itself would not have matched.

Security

API_Key

Path

censusIdinteger, (int64)required

Unique identification number for a site census

Query

baseDomainstringrequired

The URL base domain the folder belongs to.

hoststringrequired

The URL hostname the folder belongs to.

folderPathstringrequired

The normalized path key of the folder whose direct URLs to return.

searchPatternstring

Restricts the listing to pages whose own name - the last path segment - contains this case-insensitive substring, matched exactly as the url-folders search matches page hits. Glob * is treated as the dynamic-segment symbol. Blank or omitted returns every direct URL in the folder.

pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0

pageSizeinteger, [ 100 .. 1000 ]

Default:100

sortBystring

Default:"URL"

Enum:"URL""STATUS_CODE""LAST_FOUND"

sortDescboolean

Controls sorting order

Default:false

GET

/v3/site-censuses/{censusId}/folders/urls

curl -i -X GET \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/folders/urls?baseDomain=string&host=string&folderPath=string&searchPattern=string&page=0&pageSize=100&sortBy=URL&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

urlsArray of objects, >= 0 itemsrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "urls": [
    { … }
  ]
}