The mPulse App API Key, which can be found in the mPulse UI, under the General tab of the Configure Web App dialog.

Enum Metric to query for, BounceRate by default.

Enum Format of results. The default legacy output option is deprecated. Use json instead.

Enum Format of results for any series arrays. For the default js, series is an escaped JSON string. For json, series is a raw JSON object.

Date for the query. Specify the date parameter in YYYY-MM-DD format (ISO 8601). The current day is assumed if both date and date-comparator are absent.

Enum Relative date for the query. If you use Between or Last, then specify the date parameter in YYYY-MM-DD format (ISO 8601). If you use Last, also specify trailing-seconds. If you use Between, also specify date-start and date-end. The default value is Today if both date and date-comparator are absent.

Start date for date-comparator=Between. Specified in YYYY-MM-DD format (ISO 8601).

End date for date-comparator=Between. Specified in YYYY-MM-DD format (ISO 8601). Must be greater than date-start.

Timezone for the query, UTC by default. Timezone names need to be parseable by Java. For example, US/Eastern, Europe/London, and Asia/Shanghai.

Limits results to the specified AB Test dimension. Alias of the legacy test parameter.

Enum Limits results to the specified Bandwidth Block dimension. Choose 0 for less than 64Kbps, 1 for 64-512 Kbps, 2 for 512 Kbps-2 Mbps, 3 for 2-6 Mbps, 4 for 6-10 Mbps, 5 for 10-100 Mbps, or 6 for 100-1000 Mbps. Use .NONE to limit to beacons where no bandwidth was calculated.

Limits results to the specified Browser Version dimension. Alias of the legacy user-agent parameter.

Limits results to the specified Browser Family dimension.

Limits results to the specified Connection Type dimension.

Limits results to the specified Country dimension. 2-character country code (ISO 3166-1 alpha-2).

Limits results to the specified Device Manufacturer dimension.

Limits results to the specified Device Model dimension.

Enum Limits results to the specified device type dimension, either Mobile, Desktop, or Tablet.

Limits results to the specified ISP dimension.

Limits results to the specified Operating System dimension.

Limits results to the specified Operating System Family dimension.

Limits results to the specified Region dimension. 2-character region code (ISO 3166-1 alpha-2). Must specify country parameter as well.

Limits results to the specified Site Version dimension.

Limits results to the specified custom dimension. Replace {label} with the name of the custom dimension, lowercased with any spaces replaced by underscores (_). For example, a custom dimension named User Name should appear as &custom-dimension-user_name=A. Use .NONE to limit to beacons where no custom dimension was captured.

All calls to this API require that you pass in the token you get from the Generate a token operation as an Authentication request header. See Get started for help to initially call the API.