Returns a summary of the current census results data

v3 API/

Returns a summary of the current census results data

Request

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

Security

API_Key

Path

censusIdinteger, (int64)required

Unique identification number for a site census

Query

pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0

pageSizeinteger, [ 100 .. 1000 ]

Default:100

sortBystring

Default:"TOTAL_URLS"

Enum:"TOTAL_URLS""URL_PATTERN""URLS_TO_VISIT""VISITED_URLS""BROKEN_URLS""LAST_FOUND"

sortDescboolean

Controls sorting order

Default:false

searchPatternstring

Search grouping pattern to filter results

returnExcludedOnlyboolean

Indicates that the results will only contain patterns for excluded URLs. Excluded URLs include external URLs linked from included pages, and internal URLs matching an IGNORE filter pattern.

GET

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

curl -i -X GET \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/current-results?page=0&pageSize=100&sortBy=TOTAL_URLS&sortDesc=false&searchPattern=string&returnExcludedOnly=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

paginatedUrlPatternResultsArray of objects, >= 0 itemsrequired

resultsSummaryobjectrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "paginatedUrlPatternResults": [
    { … }
  ],
  "resultsSummary": {
    "uniqueUrls": 0,
    "visitedUrls": 0,
    "urlsToVisit": 0,
    "ignoredUrls": 0,
    "brokenUrls": 0,
    "isRunning": true,
    "isArchived": true
  }
}