Skip to content
v3 API/
/
Returns a preview of the...

Returns a preview of the current census results data given specific path patterns

Request

POST /v3/site-censuses/{censusId}/current-results/url-preview
Security
API_Key
Path
censusIdinteger, (int64)required

Unique identification number for a site census

Bodyapplication/jsonrequired

The URL pattern for which a preview is desired

fqdnstringrequired

The fully qualified domain name (FQDN) of the URL pattern.

renderedPathPatternstringrequired

The rendered path of the URL pattern with the dynamic segment character. Not meant for display.

POST
/v3/site-censuses/{censusId}/current-results/url-preview
curl -i -X POST \
  'https://api.observepoint.com/v3/site-censuses/{censusId}/current-results/url-preview' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "fqdn": "string",
    "renderedPathPattern": "string"
  }'

Responses

Successful operation

Bodyapplication/json
censusIdinteger, (int64)required

The unique identifier for the Site Census.

totalUrlsintegerrequired
urlsArray of strings, >= 0 itemsrequired
Response
{
  "censusId": 0,
  "totalUrls": 0,
  "urls": [
    "string"
  ]
}