# Get all censuses for an account

GET /v3/site-censuses

Endpoint: GET /v3/site-censuses
Security: API_Key

## Query parameters:

  - `page` (integer)
    Number of results page of an endpoint with paginated results

  - `pageSize` (integer)

  - `sortBy` (string)
    Enum: "NAME", "UNIQUE_URLS", "VISITED_URLS", "URLS_TO_VISIT", "EXTERNAL_LINKS", "BROKEN_URLS", "SCAN_DATE"

  - `sortDesc` (boolean)
    Controls sorting order

  - `filterByName` (string)

## Response 200 fields (application/json):

  - `metadata` (object, required)
    Common metadata for iterable

  - `metadata.pagination` (object, required)

  - `metadata.pagination.totalCount` (integer, required)
    Total number of items available from all result pages combined

  - `metadata.pagination.totalPageCount` (integer, required)
    Total number of pages available

  - `metadata.pagination.pageSize` (integer, required)
    Page size - number of items per result page configured by size query parameter or default page size

  - `metadata.pagination.currentPageSize` (integer, required)
    Number of items in current result page

  - `metadata.pagination.currentPageNumber` (integer, required)
    Current page number/ordinal

  - `censuses` (array, required)

  - `censuses.uniqueUrls` (integer, required)
    The number of unique included URLs found. Included is defined as URLs that share the same main-domain as any starting URL.

  - `censuses.visitedUrls` (integer, required)
    The number of included URLs visited. Included is defined as URLs that share the same main-domain as any starting URL.

  - `censuses.urlsToVisit` (integer, required)
    The number of included URLs to visit. Included is defined as URLs that share the same main-domain as any starting URL.

  - `censuses.externalLinks` (integer, required)
    The number of external links found on included pages. Included is defined as URLs that share the same main-domain as any starting URL.

  - `censuses.brokenUrls` (integer, required)
    The number of included URLs that are broken. Broken is defined as URLs that return a non-2xx,3xx status code. Included is defined as URLs that share the same main-domain as any starting URL.

  - `censuses.isRunning` (boolean, required)
    Indicates whether the Site Census is currently scanning.

  - `censuses.censusConfig` (object, required)

  - `censuses.censusConfig.id` (integer, required)
    The unique identifier for the Site Census.

  - `censuses.censusConfig.accountId` (integer)
    The account ID associated with the Site Census.

  - `censuses.censusConfig.name` (string, required)
    The name of the Site Census.

  - `censuses.censusConfig.autoPauseAfter` (integer, required)
    The max time the scan will run, in minutes.

  - `censuses.censusConfig.ownerId` (integer)
    The userId of the user who created the Site Census.

  - `censuses.censusConfig.currentScanStartedAt` (string,null)
    The date and time when the current scan session started.

  - `censuses.censusConfig.lastScanStoppedAt` (string,null)
    The date and time when the last scan session stopped.

  - `censuses.censusConfig.notificationEmails` (array, required)
    Target email addresses for notification when this census auto-pauses or runs out of URLs.

  - `censuses.censusConfig.startingUrls` (array, required)
    The list of starting URLs for the Site Census.

  - `censuses.censusConfig.filterPatterns` (array, required)

  - `censuses.censusConfig.filterPatterns.pathPattern` (string, required)
    The GLOB pattern to match the path of the URL.

  - `censuses.censusConfig.filterPatterns.fqdn` (string, required)
    The fully qualified domain name (FQDN) to match against the URL.

  - `censuses.censusConfig.filterPatterns.type` (string, required)
    Indicates whether matches should be prioritized or ignored.
    Enum: "PRIORITY", "IGNORE"

## Response 401 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)

## Response 403 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)