Get timers and metrics

get

https://mpulse.soasta.com/concerto/mpulse/api/v2/{apiKey}/timers-metrics

Gets the values for multiple timers or metrics by minute over time. You can use metric and timer parameters more than once.

Path Params

apiKey

string

required

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

Query Params

metric

string

enum

Defaults to Beacons

Enum Metric to query for, Beacons by default.

timer

string

enum

Defaults to PageLoad

Enum Timer to query for, PageLoad by default. Use the custom-timer=name parameter to specify the Custom Timer's name, instead of using timer=CustomTimer[0-9] which specifies the Custom Timer's index.

custom-timer

string

Name of the custom timer to be queried for. Use this instead of the timer parameter.

format

string

enum

Defaults to legacy

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

Allowed:

date

string

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.

date-comparator

string

enum

Defaults to Today

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.

trailing-seconds

number

Number of seconds for date-comparator=Last.

date-start

string

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

date-end

string

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

timezone

string

Defaults to UTC

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

percentile

integer

1 to 99

Defaults to 50

Percentile to query for, 50 by default.

ab-test

string

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

bandwith-block

string

enum

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.

beacon-type

string

enum

Enum Limits results to the specified beacon type dimension. Valid types are page view, manual for JavaScript, xhr for XMLHttpRequest or Fetch, spa_hard and spa for Single Page App (both hard and soft) api_custom_timer, api_custom_metric, error, or amp.

browser

string

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

browser-family

string

Limits results to the specified Browser Family dimension.

connection-type

string

Limits results to the specified Connection Type dimension.

country

string

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

device-manufacturer

string

Limits results to the specified Device Manufacturer dimension.

device-model

string

Limits results to the specified Device Model dimension.

device-type

string

enum

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

Allowed:

isp

string

Limits results to the specified ISP dimension.

network-error-code

string

Limits results to the specified Network Error Code.

string

Limits results to the specified Operating System dimension.

os-family

string

Limits results to the specified Operating System Family dimension.

page-group

string

Limits results to the specified Page Group dimension.

region

string

length between 2 and 2

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

site-version

string

Limits results to the specified Site Version dimension.

custom-dimension-{label}

string

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.

Headers

Authentication

string

required

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.

Responses

400

Bad request.

401

Unauthorized. The security token may be invalid. Security tokens last 5 hours, if idle. See Get started for help initially running the API.

429

Too many requests. See Rate limiting for more details.

500

Internal error.

200Timer and Metric values by minute.