This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
Bodyapplication/jsonrequired
Updated remote file mapping data
A user-supplied name to identify this RFM config
Example: "Google Analytics Replacement"
A string GUID used as the uploaded replacement file's "name" in S3
Example: "8c59d02b-6ebc-4893-9391-9be26c6d34cc"
The replacement URL, or else the name of the replacement file before it was uploaded
Example: "https://example.com/replacement-script.js"
- ObservePoint Production APIhttps://api.observepoint.com/v3/remote-file-mappings/{rfmId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api.observepoint.com/v3/remote-file-mappings/123 \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"name": "Google Analytics Replacement",
"fileId": "8c59d02b-6ebc-4893-9391-9be26c6d34cc",
"fileUrl": "https://example.com/replacement-script.js",
"matchType": "equals",
"matchValue": "https://www.google-analytics.com/analytics.js"
}'Remote file mapping updated successfully
A user-supplied name to identify this RFM config
Example: "Google Analytics Replacement"
A string GUID used as the uploaded replacement file's "name" in S3
Example: "8c59d02b-6ebc-4893-9391-9be26c6d34cc"
The replacement URL, or else the name of the replacement file before it was uploaded
Example: "https://example.com/replacement-script.js"
The request URL to be replaced (or the regex that matches URLs to replace)
Example: "https://www.google-analytics.com/analytics.js"
Foreign key reference to accounts table. The owner of this RemoteFileMapping
Example: 343
Foreign key reference to the users table. Who created this RFM?
Example: 1362
Foreign key reference to the users table. Who updated this RFM most recently?
Example: 1362
Response
application/json
{ "id": 123, "name": "Google Analytics Replacement", "fileId": "8c59d02b-6ebc-4893-9391-9be26c6d34cc", "fileUrl": "https://example.com/replacement-script.js", "matchType": "equals", "matchValue": "https://www.google-analytics.com/analytics.js", "accountId": 343, "createdBy": 1362, "createdAt": "2024-01-01T10:15:00.000Z", "updatedBy": 1362, "updatedAt": "2024-01-02T10:15:00.000Z" }
- ObservePoint Production APIhttps://api.observepoint.com/v3/remote-file-mappings/{rfmId}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://api.observepoint.com/v3/remote-file-mappings/123 \
-H 'Authorization: YOUR_API_KEY_HERE'