You can use the Script Management API to retrieve and create Script Management policies. With a policy, you can specify which scripts to block or defer automatically and enable single-point-of-failure (SPOF) protection on your site. This can help minimize performance impacts from a JavaScript.

  • SPOF protection moves a call for a script to the background if it impacts page loading.
  • SPOF protection intervenes when a script exceeds a timeout value, which adjusts automatically in response to network conditions.
  • SPOF protection only applies to third-party scripts.

The API also provides a set of accompanying insights about how scripts covered by existing policies execute.

The Script Management application

This API is a companion to the Script Management application on Akamai Control Center. This application includes metrics and analysis that show you which scripts on your site are causing large set impacts to its performance. You should review the information in the Script Management dashboard before creating any Script Management policies.

The Script Management application also includes testing suggestions to help you find the most popular pages that your policies affect, so you can confirm that Script Management is working as intended.

Additional requirements

Script Management requires ‚ÄčAkamai‚Äč's mPulse application as its source for metrics about script performance on your site. You'll need to set up support for mPulse to use Script Management.

Refer to the Script Management guide to learn more about setting up and using Script Management. To learn more about mPulse, refer to the mPulse documentation.

Common use cases

The bulk of Script Management's functionality is only available through the application on ‚ÄčControl Center‚Äč. You can create new policies and view insight data with the API. However, its most common use case is to retrieve a policy created for one hostname and then use the Property Manager API (PAPI) to apply it to many other hostnames on your property.

API Summary

See the API's various operations for details on their request parameters and response data:

OperationMethodEndpoint
Insights

Get Insights

GET

/properties/‚Äč{propertyId}/‚Äčhostnames/‚Äč{hostname}/‚Äčnetwork/‚Äč{network}/‚Äčinsights

Policies

Get a policy

GET

/properties/‚Äč{propertyId}/‚Äčhostnames/‚Äč{hostname}/‚Äčnetwork/‚Äč{network}/‚Äčpolicies

Create a policy

POST

/properties/‚Äč{propertyId}/‚Äčhostnames/‚Äč{hostname}/‚Äčnetwork/‚Äč{network}/‚Äčpolicies