# Returns a summary of the current census results data

GET /v3/site-censuses/{censusId}/current-results

Endpoint: GET /v3/site-censuses/{censusId}/current-results
Security: API_Key

## Path parameters:

  - `censusId` (integer, required)
    Unique identification number for a site census

## Query parameters:

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

  - `pageSize` (integer)

  - `sortBy` (string)
    Enum: "TOTAL_URLS", "URL_PATTERN", "URLS_TO_VISIT", "VISITED_URLS", "BROKEN_URLS", "LAST_FOUND"

  - `sortDesc` (boolean)
    Controls sorting order

  - `searchPattern` (string)
    Search grouping pattern to filter results

  - `returnExternalOnly` (boolean)
    Indicates that the results will only contain patterns for excluded URLs that are found on external links from included pages

## 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

  - `paginatedUrlPatternResults` (array, required)

  - `paginatedUrlPatternResults.urlPattern` (object, required)
    The ObservePoint proprietary pattern used to classify URLs with similar paths based upon dynamic path segments.

  - `paginatedUrlPatternResults.urlPattern.fqdn` (string, required)
    The fully qualified domain name (FQDN) of the URL pattern.

  - `paginatedUrlPatternResults.urlPattern.renderedPathPattern` (string, required)
    The rendered path of the URL pattern with the dynamic segment character. Not meant for display.

  - `paginatedUrlPatternResults.urlPattern.urlSegments` (array, required)
    The list of URL path segments.  Construct a full path pattern by appending the segment in order of array index separated by forward slashes.

  - `paginatedUrlPatternResults.urlPattern.urlSegments.segmentType` (string, required)
    The type of segment in the path. A static segment is a string in the path that does not represent a variable. 
A dynamic segment is one that represents a variable in the URL. For example, a dynamic segment could be a user ID.
    Enum: "STATIC", "DYNAMIC"

  - `paginatedUrlPatternResults.urlPattern.urlSegments.staticSegmentValue` (string)
    present when segment type is static. A static segment is a string in the path that does not represent a variable.

  - `paginatedUrlPatternResults.urlPattern.urlSegments.dynamicSegmentType` (string)
    present when segment type is dynamic. Use this type to make rendering decisions when displaying path segments.
    Enum: "NUMBER", "DATETIME", "ALPHA", "ALPHA_NUMERIC"

  - `paginatedUrlPatternResults.totalUrls` (integer, required)
    The total number of URLs within this pattern.

  - `paginatedUrlPatternResults.urlsToVisit` (integer, required)
    The number of URLs in this pattern that can still be visited.

  - `paginatedUrlPatternResults.visitedUrls` (integer, required)
    The number of URLs in this pattern that have been visited.

  - `paginatedUrlPatternResults.brokenUrls` (integer, required)
    The number of URLs in this pattern that have been visited, but returned with 4xx or 5xx status codes.

  - `paginatedUrlPatternResults.latestFound` (string)
    The date and time of the last URL in this pattern that was found in ISO 8601 format

  - `resultsSummary` (object, required)

  - `resultsSummary.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.

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

  - `resultsSummary.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.

  - `resultsSummary.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.

  - `resultsSummary.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.

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

## 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)

## Response 404 fields (application/json):

  - `timestamp` (string)

  - `message` (string)

  - `details` (string)

  - `validationReport` (object)