Get all censuses for an account

v3 API/

Get all censuses for an account

Request

GET /v3/site-censuses

Security

API_Key

Query

pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0

pageSizeinteger, [ 10 .. 1000 ]

Default:10

sortBystring

Default:"NAME"

Enum:"NAME""UNIQUE_URLS""VISITED_URLS""URLS_TO_VISIT""IGNORED_URLS""BROKEN_URLS""SCAN_DATE"

sortDescboolean

Controls sorting order

Default:false

filterByNamestring

GET

/v3/site-censuses

curl -i -X GET \
  'https://api.observepoint.com/v3/site-censuses?page=0&pageSize=10&sortBy=NAME&sortDesc=false&filterByName=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Successful operation

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

censusesArray of objects, >= 0 itemsrequired

Response

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