Returns the rolled-up counts for a single site-census folder

Request

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

Reads the precomputed rollup counts for one folder from site_census_url_folders (trustworthy only when finalized is true), plus live included/ignored URL counts computed over the folder's subtree.

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 selected folder.

GET

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

curl -i -X GET \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/folders/summary?baseDomain=string&host=string&folderPath=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

censusIdinteger, (int64)required

baseDomainstringrequired

hoststringrequired

folderPathstringrequired

totalUrlsinteger, >= 0required

Self-inclusive total URLs in this folder and all descendants (descendant_page_count).

directUrlsinteger, >= 0required

URLs sitting directly in this folder (not descendants).

childFolderCountinteger, >= 0required

Number of immediate child folders.

visitedUrlsinteger, >= 0required

Visited URLs in the subtree (success + redirect + broken buckets).

urlsToVisitinteger, >= 0required

Not-yet-categorized URLs in the subtree (unknown-status bucket); ~0 for a finalized census.

brokenUrlsinteger, >= 0required

URLs in the subtree with a 4xx/5xx status.

includedUrlsinteger, >= 0required

Live count of subtree URLs NOT matching any IGNORE pattern.

ignoredUrlsinteger, >= 0required

Live count of subtree URLs matching an IGNORE pattern.

finalizedbooleanrequired

True when the folder's precomputed rollup counts have been finalized and are trustworthy.

Response

{
  "censusId": 0,
  "baseDomain": "string",
  "host": "string",
  "folderPath": "string",
  "totalUrls": 0,
  "directUrls": 0,
  "childFolderCount": 0,
  "visitedUrls": 0,
  "urlsToVisit": 0,
  "brokenUrls": 0,
  "includedUrls": 0,
  "ignoredUrls": 0,
  "finalized": true
}