Real User Measurements API

• Beacon Administration

  • List Methods
  • Expand Methods

  • POSTCreate a Beacon/rum/1.0/beacon
    Creates a new Real User web beacon and returns 'jsTag', the JavaScript tag that you should copy and paste into your website's HTML header section.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconName		string	The name of this beacon

    
    
  • GETList Beacons/rum/1.0/beacon
    Retrieves a list of all RUM beacons associated with your account, along with information about each. The beacon id that is returned is used to make other api calls.
    
    
    

    Output Variables:

    Variable	Possible Values	Description
    beaconId	string	The ID of the beacon.
    jsTag	string	The RUM JavaScript tag to copy and paste into your website's HTML header section.
    preferences.beaconName	string	The name of this beacon.
    preferences.samplingRate	float	A number between 0 and 1 to represent the sampling rate for this beacon.
    preferences.maxLoadTime	int	The maximum load time (ms) allowed per measurement.
    stats.collected	int	Measurements successfully saved into our servers.
    stats.unsupportedBrowser	int	Browsers that do not support Navigation Timing API.
    stats.uaExcluded	int	Excluded because requests came from Vercara monitoring or load testing agents.
    stats.unknownBrowser	int	Unable to identify the browser (bots, crawlers, etc.).
    stats.maxTplt	int	Measurements reported total page load time above threshold defined by preferences.maxLoadTime.
    stats.sampledOut	int	Requests have been discarded because of collection sampling defined by preferences.samplingRate.
    stats.throttled	int	Requests have been throttled.
    stats.total	int	Total requests received by our servers.

    
    
  • PUTUpdate A Beacon/rum/1.0/beacon/:beaconID
    Change some or all of the preferences of an existing beacon. Requires the beacon ID retrieved from the List Beacons api.
    
    

    Input Variables:

    URL Variable	Value
    beaconID

    
    

    Parameter	Value	Type	Description
    beaconName		string	The name of the beacon
    maxLoadTime		int	The maximum load time (ms) allowed per measurement.
    samplingRate		float	A number between 0 and 1 to represent the sampling rate for this beacon.

    
    
  • DELETEDelete a Beacon/rum/1.0/beacon/:beaconID
    Delete the given beacon. RUM data will no longer be collected for that beacon. Requires the beacon ID retrieved from the List Beacons api.
    
    

    Input Variables:

    URL Variable	Value
    beaconID

    
    
    

• Data Information

  • List Methods
  • Expand Methods

  • GETGet Performance Summary On Recent Data/rum/1.0/data/summary
    Recent RUM data is aggregated to provide a short, easy to read summary.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    minutes		number	The number of minutes (between 1 and 60) to aggregate on. If this parameter is missing, the last 5 minutes worth of RUM data will be used to calculate the summary.
    allbeacons	01	enumerated	If this flag is set to 1 the server will return a list of summary data for all this account's beacons.

    
    

    Output Variables:

    Variable	Possible Values	Description
    cnt	int	Number of page hits collected.
    averagePageLoadTime	int	The average page load time (s).
    averageTimeToFirstByte	int	The average time to first byte (s).
    averageTimeToDomReady	int	The average time to DOM ready (s).
    apdexScore	int	The Apdex score.
    jsErr	int	Number of pages with captured JavaScript errors.
    dns_cnt	int	The number of measurements collected that include DNS timing data. DNS timing is not always available as browsers use cached DNS information.
    averageDNSTime	int	The average DNS time (s).
    p_cnt	int	The number of measurements collected that include perceived load time information.
    p_err	int	The number of perceived load time errors captured ('timeout' or 'onbeforeunload' events).
    averagePerceivedLoadTime	int	The average perceived page load time (s).

    
    
  • GETGet Recent Time Series Data/rum/1.0/data/ts/recent
    Returns RUM's recently aggregated minute-level data.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    minutes		number	The number of minutes (between 1 and 60) to return. If this parameter is missing, the last 5 minutes worth of RUM data will be returned.

    
    

    Output Variables:

    Variable	Possible Values	Description
    ts	string	The ISO 8601 formatted time string representing the minute (UTC) this data was aggregated for.
    cnt	int	Number of page hits collected for the given minute.
    tplt	int	The accumulated page load time (ms) for the given minute.
    tdlt	int	The accumulated dom load time (ms) for the given minute. Subtracting this value from the 'tplt' value will give you the accumulated Time To First Byte for the given minute.
    low	int	The single lowest page load time (ms) collected for the given minute.
    high	int	The single highest page load time (ms) collected for the given minute.
    apdex	int	The Apdex score for the given minute.
    ttdr	int	The accumulated time to DOM ready (ms) for the given minute.
    p_cnt	int	The number of measurements collected that include perceived load time information for the given minute.
    p_err	int	The number of perceived load time errors captured ('timeout' or 'onbeforeunload' events) for the given minute.
    p_lt	int	The accumulated perceived page load time (ms) for the given minute.
    jsErr	int	Number of pages with captured JavaScript errors for the given minute.

    
    
  • GETGet Time Series Data/rum/1.0/data/ts
    Returns RUM time series data for a given time period.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    startDate		string	An ISO 8601 formatted date string representing the start date in UTC from which you wish to retrieve time series data. Example: 2012-06-01T00:00:00Z
    endDate		string	An ISO 8601 formatted date string representing the end date in UTC until which you wish to retrieve time series data. Example: 2012-06-05T00:00:00Z
    type	daily	enumerated	If set to 'daily' this API will return day-level aggregated data. Otherwise this API will return minute-level aggregated data.

    
    

    Output Variables:

    Variable	Possible Values	Description
    ts	string	The ISO 8601 formatted time string representing the day or month (UTC) the time series data that follows was aggregated for.
    hours	array	A list of hours containing the data objects per hour.
    hour	int	The hour from 0 to 23 the data that follow is for.
    cnt	int	Number of page hits collected for the given hour or minute.
    tplt	int	The accumulated page load time (ms) for the given hour or minute.
    tdlt	int	The accumulated dom load time (ms) for the given minute. Subtracting this value from the 'tplt' value will give you the accumulated Time To First Byte for the given hour or minute.
    low	int	The single lowest page load time (ms) collected for the given hour or minute.
    high	int	The single highest page load time (ms) collected for the given hour or minute.
    ttdr	int	The accumulated time to DOM ready (ms) for the given hour or minute.
    p_cnt	int	The number of measurements collected that include perceived load time information for the given hour or minute.
    p_err	int	The number of perceived load time errors captured ('timeout' or 'onbeforeunload' events) for the given hour or minute.
    p_lt	int	The accumulated perceived page load time (ms) for the given hour or minute.
    apdex	int	The Apdex score for the given hour or minute.
    jsErr	int	Number of pages with captured JavaScript errors for the given hour or minute.
    buckets	array	An array of 6 objects containing the number of hits per page load time bucket for a given hour. Buckets are set for the following page load times: 0 to 2 seconds, 2 to 4, 4 to 6, 6 to 8, 8 to 10, and 10 and up seconds.
    mins	array	A list of minutes containing the data objects per minute.
    min	int	The minute from 0 to 59 the data that follows is for.
    days	array	A list of days containing the data objects per day.
    day	int	The day from 1 to the number of days for that month the data that follows is for.

    
    
  • GETGet Raw Data/rum/1.0/data/raw
    Returns samples from the raw data collected for a given time period. At a maximum, this api will return 2,000 samples. If there are more than 2,000 samples available for this time range, the 'more' field will be set to true and you can make another api call specifying an offset which would be equal to the number of results returned in the first api call plus the offset of that call. Only the last 7 days worth of raw data is available.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    startDate		string	An ISO 8601 formatted datetime string representing the start time in UTC from which you wish to retrieve raw data. Example: 2012-05-30T20:10:00Z
    endDate		string	An ISO 8601 formatted datetime string representing the end time in UTC until which you wish to retrieve raw data. Example: 2012-05-30T20:11:00Z
    offset		int	From which position in the return list you wish to start. Default is 0.
    limit		int	Specify a maximum number of results to return. Default (and max) is 2000.
    orderbypageloadtime		string	Set this parameter to either 'asc' or 'desc' if you want the raw data returned either in ascending or descending order of page load time. If this parameter is not present, the default is to return the data in natural chronological order.
    errorsonly	01	enumerated	Set this flag to 1 if you want results to only include samples that returned JavaScript errors.
    urlexact		string	Filter raw samples by the exact url.
    url		string	Filter raw samples by url using a regular expression.
    browser	chromefirefoxIEandroid	enumerated	Filter raw samples by browser.
    connection_type	ocxtxdslcableisdnmobile wireless	enumerated	Filter raw samples by connection type.
    country	afghanistanaland islandsalbaniaalgeriaamerican samoaandorraangolaanguillaantarcticaantigua and barbudaargentinaarmeniaarubaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbermudabhutanboliviabosnia and herzegovinabotswanabouvet islandbrazilbritish indian ocean territorybrunei darussalambulgariaburkina fasoburundicambodiacamerooncanadacape verdecaribbean netherlandscayman islandscentral african republicchadchilechinachristmas islandcocos (keeling) islandscolombiacomoroscongocook islandscosta ricacote d'ivoirecroatiacubacuracaocyprusczech republicdemocratic republic of the congodenmarkdjiboutidominicadominican republicecuadoregyptel salvadorequatorial guineaeritreaestoniaethiopiafalkland islands (malvinas)faroe islandsfijifinlandfrancefrench guianafrench polynesiafrench southern territoriesgabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguadeloupeguamguatemalaguernseyguineaguinea-bissauguyanahaitiholy see (vatican city state)hondurashong konghungaryicelandindiaindonesiairaniraqirelandisle of manisraelitalyjamaicajapanjerseyjordankazakhstankenyakiribatikorea (north)korea (south)kuwaitkyrgyzstanlaoslatvialebanonlesotholiberialibyaliechtensteinlithuanialuxembourgmacaumacedoniamadagascarmalawimalaysiamaldivesmalimaltamarshall islandsmartiniquemauritaniamauritiusmayottemexicomicronesiamoldovamonacomongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew caledonianew zealandnicaraguanigernigerianiuenorfolk islandnorthern mariana islandsnorwayoccupied palestinian territoryomanpakistanpalaupanamapapua new guineaparaguayperuphilippinespitcairnpolandportugalpuerto ricoqatarreunionromaniarussian federationrwandasaint barthelemysaint helenasaint kitts and nevissaint luciasaint martinsaint pierre and miquelonsaint vincent and the grenadinessamoasan marinosao tome and principesaudi arabiasenegalserbiaseychellessierra leonesingaporesint maartenslovak republicsloveniasolomon islandssomaliasouth africasouth sudanspainsri lankasudansurinamesvalbard and jan mayenswazilandswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotokelautongatrinidad and tobagotunisiaturkeyturkmenistanturks and caicos islandstuvaluugandaukraineunited arab emiratesunited kingdomunited statesuruguayuzbekistanvanuatuvenezuelaviet namvirgin islands (british)virgin islands (u.s.)wallis and futuna islandswestern saharayemenzambiazimbabwe	enumerated	Filter raw samples by country.
    jserr		string	Regex to filter raw samples by JS error filename or string.
    ipr	12345	enumerated	Filter raw samples by IP Reputation Score: 1 - Very Low Risk, 2 - Low Risk, 3 - Moderate Risk, 4 - High Risk, 5 - Very High Risk.

    
    

    Output Variables:

    Variable	Possible Values	Description
    ts	string	The ISO 8601 formatted time string representing the UTC time this sample has been collected.
    u	int	The URL of the page visited this measurement was taken from.
    r	string	The referrer URL of the page visited. null if no referrer detected.
    t_page	int	The total page load time (ms).
    t_dom	int	The DOM load and processing time (ms).
    t_dns	int	The DNS time (ms).
    t_redirect	int	The redirect time (ms).
    t_domready	int	The time to DOM ready (ms).
    pcv	object	Contains perceived page load time (ms), error, and description information.
    c_err	int	The number of JavaScript errors captured.
    jsErrors	int	An array containing up to 5 JavaScript errors captured. Each element of the array contains the file name, the line number, and the error message where the error occurred. Note that the strings are encoded. In Javascript use unescape() to decode.
    ua	object	json object containing the user agent information (see below). If any of the data was not available, the field value will be null.
    co	string	The country of origin of the collected data.
    st	string	The state/province of origin of the collected data.
    city	string	The city of origin of the collected data.
    asn	string	The Autonomous System Number of origin of the collected data.
    ct	string	Connection Type: type of connection to the Internet of the originated user agent.
    iprt	string	IP Routing Type: how the connection of the originated user agent is routed through the Internet.
    anonymizer	string	Anonymizer Status: Indicates whether the originated user agent's detected IP address is associated with a known anonymous proxy, and that proxy's status as measured by Vercara IP Intelligence.
    br	string	Browser name and major version number the data was collected from.
    ipr	int	IP Reputation Score: how suspicious the originated user agent is based on its IP address. 1 - Very Low Risk, 2 - Low Risk, 3 - Moderate Risk, 4 - High Risk, 5 - Very High Risk

    
    
  • GETGet Analysis Data/rum/1.0/data/analysis
    Returns RUM raw data filtered by the request parameters for a given time period, and grouped by a given key or over time. The maximum time period allowed is 24 hours as this API should be mostly used for alerting purposes.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    startDate		string	An ISO 8601 formatted datetime string representing the start time in UTC from which you wish to retrieve raw data. Example: 2012-05-30T20:10:00Z
    endDate		string	An ISO 8601 formatted datetime string representing the end time in UTC until which you wish to retrieve raw data. Example: 2012-05-30T20:11:00Z
    groupby	urljserrbrowsercountrystateconnection_typeasniprip_routing_typeanonymizer_status	enumerated	Key to group the data by. This parameter is required if the 'overtime' parameter is not set to 1.
    overtime	01	enumerated	Set this flag to 1 if you want results to be returned over time. If this flag is not set to 1 the 'groupby' field becomes required. Note that this parameter is ignored when grouping by JS error.
    url		string	Regex to filter raw samples by url. For example, in order to only retrieve measurements from a .us domain we could use the string '.*\.us\/'
    browser	chromefirefoxIEandroid	enumerated	Filter raw samples by browser.
    connection_type	ocxtxdslcableisdnmobile wireless	enumerated	Filter raw samples by connection type.
    country	afghanistanaland islandsalbaniaalgeriaamerican samoaandorraangolaanguillaantarcticaantigua and barbudaargentinaarmeniaarubaaustraliaaustriaazerbaijanbahamasbahrainbangladeshbarbadosbelarusbelgiumbelizebeninbermudabhutanboliviabosnia and herzegovinabotswanabouvet islandbrazilbritish indian ocean territorybrunei darussalambulgariaburkina fasoburundicambodiacamerooncanadacape verdecaribbean netherlandscayman islandscentral african republicchadchilechinachristmas islandcocos (keeling) islandscolombiacomoroscongocook islandscosta ricacote d'ivoirecroatiacubacuracaocyprusczech republicdemocratic republic of the congodenmarkdjiboutidominicadominican republicecuadoregyptel salvadorequatorial guineaeritreaestoniaethiopiafalkland islands (malvinas)faroe islandsfijifinlandfrancefrench guianafrench polynesiafrench southern territoriesgabongambiageorgiagermanyghanagibraltargreecegreenlandgrenadaguadeloupeguamguatemalaguernseyguineaguinea-bissauguyanahaitiholy see (vatican city state)hondurashong konghungaryicelandindiaindonesiairaniraqirelandisle of manisraelitalyjamaicajapanjerseyjordankazakhstankenyakiribatikorea (north)korea (south)kuwaitkyrgyzstanlaoslatvialebanonlesotholiberialibyaliechtensteinlithuanialuxembourgmacaumacedoniamadagascarmalawimalaysiamaldivesmalimaltamarshall islandsmartiniquemauritaniamauritiusmayottemexicomicronesiamoldovamonacomongoliamontenegromontserratmoroccomozambiquemyanmarnamibianaurunepalnetherlandsnew caledonianew zealandnicaraguanigernigerianiuenorfolk islandnorthern mariana islandsnorwayoccupied palestinian territoryomanpakistanpalaupanamapapua new guineaparaguayperuphilippinespitcairnpolandportugalpuerto ricoqatarreunionromaniarussian federationrwandasaint barthelemysaint helenasaint kitts and nevissaint luciasaint martinsaint pierre and miquelonsaint vincent and the grenadinessamoasan marinosao tome and principesaudi arabiasenegalserbiaseychellessierra leonesingaporesint maartenslovak republicsloveniasolomon islandssomaliasouth africasouth sudanspainsri lankasudansurinamesvalbard and jan mayenswazilandswedenswitzerlandsyriataiwantajikistantanzaniathailandtimor-lestetogotokelautongatrinidad and tobagotunisiaturkeyturkmenistanturks and caicos islandstuvaluugandaukraineunited arab emiratesunited kingdomunited statesuruguayuzbekistanvanuatuvenezuelaviet namvirgin islands (british)virgin islands (u.s.)wallis and futuna islandswestern saharayemenzambiazimbabwe	enumerated	Filter raw samples by country.
    jserr		string	Regex to filter raw samples by JS error filename or string.
    ipr	12345	enumerated	Filter raw samples by IP Reputation Score: 1 - Very Low Risk, 2 - Low Risk, 3 - Moderate Risk, 4 - High Risk, 5 - Very High Risk.

    
    

    Output Variables:

    Variable	Possible Values	Description
    _id	string	The grouped by value.
    cnt	int	Number of page hits.
    tplt	int	The accumulated page load time (ms).
    tdlt	int	The accumulated dom load time (ms). Subtracting this value from the 'tplt' value will give you the accumulated Time To First Byte.
    apdex	int	The Apdex score.
    ttdr	int	The accumulated time to DOM ready (ms).
    dns_cnt	int	The number of measurements collected that include DNS timing data. DNS timing is not always available as browsers use cached DNS information.
    dns	int	The accumulated DNS time (ms).
    jsErr	int	Number of pages with captured JavaScript errors.
    jsErrDetailCnt	int	The number of detailed JavaScript errors actually captured. This variable is available only when grouping by JS error.
    p_cnt	int	The number of measurements collected that include perceived load time information.
    p_err	int	The number of perceived load time errors captured ('timeout' or 'onbeforeunload' events).
    p_lt	int	The accumulated perceived page load time (ms).

    
    
  • GETGet Object-Level Time Series Data/rum/1.0/data/ol/ts
    Returns RUM Object-Level time series data for a given time period.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    startDate		string	An ISO 8601 formatted date string representing the start date in UTC from which you wish to retrieve time series data. Example: 2012-06-01T00:00:00Z
    endDate		string	An ISO 8601 formatted date string representing the end date in UTC until which you wish to retrieve time series data. Example: 2012-06-05T00:00:00Z

    
    

    Output Variables:

    Variable	Possible Values	Description
    ts	string	The ISO 8601 formatted time string representing the day (UTC) the time series data that follows was aggregated for.
    hours	array	A list of hours containing the data objects per hour.
    hour	int	The hour from 0 to 23 the data that follows is for.
    cnt	int	Number of object-level measurements collected for the given hour.
    t_median	int	The accumulated median load time across all recorded objects (ms) for the given hour.
    cnt_res	int	Number of objects (page resources) recorded for the given hour.
    cnt_outlier	int	Number of outlying objects (page resources) recorded for the given hour.
    cnt_domain	int	Number of third-party domains from objects (page resources) recorded for the given hour.

    
    
  • GETGet Object-Level Outliers Data/rum/1.0/data/ol/outlier
    Returns outlying page resources grouped by name, domain, and optionnally by location. The maximum time period allowed is 24 hours as this API should be mostly used for alerting purposes.
    
    

    Input Variables:

    
    

    Parameter	Value	Type	Description
    beaconId		string	The ID of the beacon. If this parameter is missing the server will return data for the first beacon that was created for the account.
    startDate		string	An ISO 8601 formatted datetime string representing the start time in UTC from which you wish to retrieve raw data. Example: 2012-05-30T20:10:00Z
    endDate		string	An ISO 8601 formatted datetime string representing the end time in UTC until which you wish to retrieve raw data. Example: 2012-05-30T20:11:00Z
    groupby	resourcedomainlocation_resourcelocation_domain	enumerated	Key to group the data by.

    
    

    Output Variables:

    Variable	Possible Values	Description
    _id	string	The grouped by value: either the location (continent), the object's full path, or the object's domain.
    cnt	int	Number of times that outlier was recorded.
    tlt	int	The accumulated load time for a page resource or a third-party domain (ms).
    p	string	When grouping by location, an object's full path or a third-party domain.