How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ObservePoint Site Censuses API

APIs for managing Site Census

ObservePoint Site Censuses API is one of 65 APIs that ObservePoint publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include site-censuses. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 13 operations across 10 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0.

Requests are made against a single base URL, https://api.observepoint.com.

13 operations 10 paths 31 schemas 1 DELETE7 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
Base URL
https://api.observepoint.com
Authentication
API Key
Resource Areas
1

Authentication & Security 1

ObservePoint Site Censuses API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (API_Key).

  • API_Key — Use the Authorization header in your requests with ObservePoint API key as header value. Example: Authorization: abc123...def456

Paths & Operations 13

Across 10 paths, the API surfaces 13 operations — 1 DELETE, 7 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

site-censuses 13

APIs for managing Site Census

GET
/v3/site-censuses
Get all censuses for an account
getSiteCensuses 5 params → 200401403
POST
/v3/site-censuses
Create a new site census
createSiteCensus body → 200400401403
GET
/v3/site-censuses/{censusId}
Get a site census by ID
getSiteCensusById 1 param → 200400401403404
PUT
/v3/site-censuses/{censusId}
Update an existing site census
updateSiteCensusById 1 param body → 200400401403404
DELETE
/v3/site-censuses/{censusId}
Delete a site census by ID
deleteSiteCensusById 1 param → 204400401403404
GET
/v3/site-censuses/{censusId}/current-results
Returns a summary of the current census results data
getSiteCensusCurrentResults 7 params → 200401403404
GET
/v3/site-censuses/{censusId}/url-folders
Browse a host's folder tree, list every host's root, or search folders and pages across the census -- each returned folder carrying a preview of its direct URLs
getSiteCensusUrlFolders 10 params → 200400401403404
GET
/v3/site-censuses/{censusId}/folders/summary
Returns the rolled-up counts for a single site-census folder
getSiteCensusFolderSummary 4 params → 200401403404
GET
/v3/site-censuses/{censusId}/folders/urls
Returns the URLs sitting directly in a site-census folder
getSiteCensusFolderUrls 9 params → 200401403404
POST
/v3/site-censuses/{censusId}/current-results/url-preview
Returns a preview of the current census results data given specific path patterns
getSiteCensusPatternUrlPreview 1 param body → 200401403404
POST
/v3/site-censuses/{censusId}/start
Starts data-collection for a given census
startSiteCensusDataCollection 1 param → 200401403404
POST
/v3/site-censuses/{censusId}/stop
Stops data-collection for a given census
stopSiteCensusDataCollection 1 param → 200401403404
GET
/v3/site-censuses/finder
Find site censuses
findSiteCensuses 3 params → 200400401403

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SiteCensusFolderSummaryDTO (13 properties), SiteCensusUrlFolderResultDTO (13 properties), SiteCensusBaseDTO (10 properties), SiteCensusResultsSummaryDTO (7 properties). Each schema is shown below with its type and property counts.

FoundSiteCensusDTO
object
Represents a site census retrieved from a search operation. Site censuses can be searched by the following properties: - id - name
3 properties 3 required
SiteCensusPatternPreviewResponse
object
3 properties 3 required
SiteCensusSortByEnum
string
SiteCensusBehaviorDTO
SiteCensusBaseDTO
object
10 properties 3 required
SiteCensusResultsSummaryDTO
object
7 properties 7 required
SiteCensusBaseUrlPattern
object
The ObservePoint proprietary pattern used to classify URLs with similar paths based upon dynamic path segments.
2 properties 2 required
SiteCensusUrlSegment
object
3 properties 1 required
SiteCensusUrlPattern
SiteCensusUrlFolderSortByEnum
string
SiteCensusUrlPatternResultsDTO
object
6 properties 5 required
SiteCensusCustomHttpHeader
object
1 property 1 required
SiteCensusFolderUrlSortByEnum
string
SiteCensusFolderUrlDTO
object
4 properties 2 required
PaginationMetadata
object
5 properties 5 required
SiteCensusUrlFolderResultsDTO
object
2 properties 2 required
SiteCensusFolderSummaryDTO
object
13 properties 13 required
SiteCensusResultsSortByEnum
string
SiteCensusSearchParam
string
Parameter to search for site censuses
SiteCensusCompleteDTO
CensusId
integer
SiteCensusUrlFolderResultDTO
object
13 properties 9 required
FoundSiteCensusesListResponseDTO
object
2 properties 2 required
ErrorModel
object
4 properties
SiteCensusUrlFolderPageDTO
object
One direct-child URL of the folder row it is nested under. In search mode its own page name matched searchPattern; in browse mode every in-view direct URL qual…
5 properties 3 required
CommonIterableResponseMetadata
object
Common metadata for iterable
1 property 1 required
SiteCensusFolderUrlsResultsDTO
object
2 properties 2 required
SiteCensusCurrentResultsDTO
object
3 properties 3 required
SiteCensusSummariesResponseDTO
object
2 properties 2 required
SiteCensusFilterPattern
object
3 properties 3 required
SiteCensusSummaryDTO

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

observepoint-site-censuses-api-openapi.yml Raw ↑

Other APIs ObservePoint publishes across the network.

ObservePoint Account API
ObservePoint Account Triggered Alerts API
ObservePoint Account Usage Alerts API
ObservePoint Account Usage Export API
ObservePoint Account Usage V2 API
ObservePoint Action Set Action Rules API
ObservePoint Action Set Actions API
ObservePoint Action Sets API
ObservePoint Alert Export API
ObservePoint Alert Summary Report API
ObservePoint Alerts API
ObservePoint Audit Actions API
Where this information came from

This is an independent, third-party profile of ObservePoint Site Censuses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.