Version 0.4 (August 2016)

Changes overview

Standardization of "visuallyComplete" ("oldVisuallyComplete" key contains the value given to "visuallyComplete" in the previous API version).
Adding "loadTime" on results of monitoring and scenarios.

List of changes

The "visuallyComplete" key is harmonized

POST/analysis/report

POST/monitoring/last-report

POST/scenario/reports

POST/scenario/step/report

"visuallyComplete" represents the last visual changes observed on the page. On some API actions, the value returned in previous API version was ignoring small visual changes. On those actions the more precise value is now returned for "visuallyComplete" and the value returned in the previous version is now set in "oldVisuallyComplete".
The key "oldVisuallyComplete" should only be used if you need to compare with results retrieved with an oldest version of the API.

...
"visuallyComplete":3367
...
...
"visuallyComplete":4215,
"oldVisuallyComplete": 3367
 ...
Add the key "loadTime" in the results of monitoring and scenario

The fully loaded time is added in monitoring and scenarios results ("loadTime" key).
Find below the routes benefiting from this addition:

POST/monitoring/reports

POST/scenario/reports

Version 0.3 (June 2016)

Changes overview

Replace "performanceTimings" by "timings" (when retrieving an analysis or the last execution for a monitoring). Standardization of the data format for the key.

List of changes

Change on retrieving a report

POST/analysis/report

Standardization of timings returned in a report.

The "performanceTiming" key both includes metrics computed by video analysis and metrics related to events triggered by the web browser. Some of these values were absolute and others relative, so using this values together was requiring post-treatments.

...
"performanceTimings":{
    "navigationStart":1464871530661,
    "firstByte":1464871530975,
    "domInteractive":1464871531623,
    "loadEvent":1464871532408,
    "startRender":1034,
    "speedIndex":2375,
    "visuallyComplete":3367
}
...

The key name changes, it's now "timings" in the version 0.3 and it contains standardized times (expressed in milliseconds since the navigation start). The "navigationTimings.navigationStart" key is removed, since it was only used for post-treatments previsouly mentioned.

The new response format

...
'timings': {
     'firstByte': 150,
     'firstPaint': 1413,
     'domInteractive': 2118,
     'loadEvent': 2216,
     'startRender': 1034,
     'speedIndex': 2375,
     'visuallyComplete': 3367
 }
 ...
Content breakdown by mime type

The distribution of resources by type has been added. So you can know the weight and number of requests based on the resource type.

The new response format

...
resourceByType:[
     {
        type:"", // js / image/ html /css /other
        bodyWeight: 0,
        headerWeight: 0,
        requestCount: 0
    }
],
...

Adding new actions related to scenario

Three new actions related to the scenario

  • Report of a scenario
  • Reports of a scenario
  • Step report of a scenario

Adding the possibility to download a PDF

Adding two actions to download a PDF report. The first route will start the generation of the PDF, and the second route will allow you to download it when the PDF when is ready.

Version 0.2 (January 2016)

Changes overview

W3C HTML validator results have become less and less useful over time, so we removed it from our reports.
Additionally we added an option to only get a summary of our analysis report.

List of changes

Change on retrieving a report

POST/analysis/report

Summary option for lighter results

We added a "metricsOnly" option in the request to get a report, allowing to get partial results (lighter), excluding advice, categories, detected technologies and W3C CSS results.

The new request format

{
    'token': '',
    'reportId': '',
    'metricsOnly': false
}
W3C HTML validator removal

We have removed the key "w3cValidators.HTML" in "report" when you get an analysis result. Indeed HTML Validator has become less and less useful and we decided to not include it anymore in our analysis results.

Version 0.1 (October 2014)

Changes overview

This is the initial release of the API, it allows to analyze any webpage, to get available configurations (locations / browsers) from Dareboost and to get the content of any performance report .