Overview
Given an Audit Aun, you can extract all the initiators on each page. A definition of an initiator is a resource that “initiators” or is a container for a subsequent resource.
Note: More information about each web page is available from the ObservePoint API, but this recipe only covers collected console logs on each page. Using this recipe as a starting point, you can expand your integration to include other information.
Step 1: Get your Audit ID and Run ID
You’ll need an Audit ID and Run ID to get started. There are multiple ways to do this, depending on your needs. The ObservePoint API is flexible, so you can use the approach that works best for you.
Here are 3 ways to get your Audit ID and Run ID:
From a webhook: If you have a webhook configured, the webhook payload will include Audit ID and Run ID. See the “Webhooks” section above for setting up webhooks.
Manually (good for one-time testing): You can find the Audit ID in the ObservePoint application under "Data Sources". Click on the Audit you want, note the Audit ID and Run ID in the address bar.
From the API: You can query the API at https://api.observepoint.com/v3/web-audits/ to get the list of Audits in your account. You can query https://api.observepoint.com/v2/web-audits/auditId/runs to get the list of recent run IDs. A common use case is to query the ObservePoint API for any run IDs you haven’t already ingested into your database.
Important: this approach uses a mix of v2 and v3 endpoints
Tip: A common scenario is to download and store Audit Run IDs in a database you control. Later, when your code runs, it can first query your database for the most recently processed run ID, and then query the ObservePoint API for any to find the next run ID that hasn’t yet been downloaded.
Step 2: Download all the pages from the Audit Run:
Make an authenticated POST request to this URL with an empty request payload:
In your code, start with page=0, and make multiple requests, incrementing the page number for each request, until you have downloaded all the web pages for this run (see the “Pagination” section above for more instructions).
Each response will look like the following. Note that this example Audit Run scanned 544 web pages, and we requested a page size of 100, so there are 6 total pages to request.
{
"metadata": {
"pagination": {
"totalCount": 544,
"totalPageCount": 6,
"pageSize": 100,
"currentPageSize": 100,
"currentPageNumber": 0
}
},
"pages": [
{
"pageId": "77ebb089815a3b8d82813ebaf6320730",
"dataCollectionUuid": "77ebb089815a3b8d82813ebaf6320730",
"pageUrl": "http://example.com/",
"pageTitle": "Example Home Page",
"pageLoadTime": 665,
"pageStatusCode": 200,
"initialPageStatusCode": 200,
"finalPageStatusCode": 200,
"redirectCount": 0,
"size": 34363
},
{
"pageId": "139cf2a71e4ecb1967b7a5b47770e66a",
"dataCollectionUuid": "139cf2a71e4ecb1967b7a5b47770e66a",
"pageUrl": "http://example.com/path",
"pageTitle": "Example Web Page",
"pageLoadTime": 1621,
"pageStatusCode": 200,
"initialPageStatusCode": 200,
"finalPageStatusCode": 200,
"redirectCount": 0,
"size": 956436
},
...
]
}
Step 3: For each web page, fetch its initiators
From step 2, you have a list of pageUrl. The next step is to query the API for the initiators which ObservePoint captured on each page.
For each page, make an authenticated POST request to this URL:
There is a payload for the above request. For an extraction use case, use the following payload format:
{"url":>pageUrl,"itemType":"audit","runId":runId}
Each response will look like this:
{
"aggregatedLoadTime": 299,
"name": "http://example.org/",
"size": 414,
"tagId": 0,
"url": "http://example.org",
"children": [
{
"aggregatedLoadTime": 295,
"name": "Adobe Launch",
"size": 45423,
"relationshipStrength": "medium",
"tagName": "Adobe Launch",
"tagId": 556,
"url": "https://assets.adobedtm.com/12345/12345/launch-12345.min.js",
"children": [
{
"aggregatedLoadTime": 278,
"name": "Adobe Audience Manager",
"size": 1010,
"relationshipStrength": "high",
"tagName": "Adobe Audience Manager",
"tagId": 181,
"url": "https://dpm.demdex.net/id",
"children": []
},
...This API endpoint returns these fields in its payload:
Field Name | Field Description |
aggregatedLoadTime |
|
name | Name of node resource |
size | Size of request in bytes |
relationshipStrength | The probability of the relationship between parent and child nodes |
tagName | If source is a known technology within the ObservePoint Tag Database, the name for said tag/technology |
tagId | If source is a known technology within the ObservePoint Tag Database, the identifier for said tag/technology |
url | Resource URL |
children | An array of resources initiated from node |
Conclusion
With all the web pages and resource initiators downloaded for this Audit Run, you can store them in a database and report/visualize them as you like.