Performance/Hits Endpoint

 site

 string

 Site the data is being pulled from. Uses the unique ID   associated with your tag.

 None

 start

 integer

 Start time of the data in epoch time.

 epoch (seconds), time period limited to 7 days

 end

 integer 

 End time of the data in epoch time.

 epoch (seconds), time period limited to 7 days

 dataColumns

 array

 Data columns to be retrieved.

Data Column available parameters

 dataType

 string

 If data returned should be for native app, RUM or synthetic.   Defaults   to “rum”. "basepage" dataType returns   data for both   base page measurements and the   advanced synthetic   scripts.

• native

• rum

• synthetic

• basepage

 url

 string

 Filters data based on a URL substring. Wildcards (*) may be used. Exact match is assumed unless wildcard(s) specified.

 pageName

 array

 Filters data by page name.

 pageGroup

 array

 Filters data by page group.

 trafficSeg

 array

 Filters data by traffic segment.

 browser

 array

 Filters data by browser.

 device

 array

 Filters data by device.

 os

 array

 Filters data by operating system.

 country

 array

 Filters data by country.

 ISO 3166 format

 region

 array

 Filters data by region. http://www.maxmind.com/download/geoip/misc/region_codes.csv

 ISO 3166 format with   region ID numbers

 netspeed

 array

 Filters data by netspeed.

• 0=Unknown

• 1=Dial-up

• 2=Cable/DSL

• 3=Corporate

• 4=Cellular

 campaignSource

 array

 Filters data by traffic source.

 campaignName

 array

 Filters data by the campaign name.

 campaignMedium

 array

 Filters data by traffic medium.

 abSegment

 array

 Filters data by an A/B segment.

 datacenter

 array

 Filters data by data center.

 botTraffic

 string

 Filters data by different types of bot traffic. Bots are excluded by   default.

• includeBots

• botsOnly

• excludeBots

 visitorType

 array

 Filters data by return visitors or new visitors. Defaults to include   both.

• returning

• new

 resourceOnly

 string

 Only shows data for sessions that captured resource data.   Defaults to "no". If set to "yes", the data returned may be   sampled.

• yes

• no

customNumber1,

customNumber2,

...

customNumber20

 array

 Filters data by Custom Number.

See Using Custom Variables.

customCategory1,

customCategory2,

...

customCategory5

 array

 Filters data by Custom Category.

See Using Custom Variables.

csid

 array

 Customer Session ID

sessionID

 integer

 BTT Session ID

guid

string

 Global User ID

measurementID

 string

 Synthetic Measurement ID

synthetic only

userAgent

 string

 Filters data based on a User-Agent string. Wildcards (*) may be used. Exact match is assumed unless wildcard(s) specified.

excluded

 array

  The data beacon type. Standard, email and custom. The array should contain either 0, 4, 20, or a combination of the 3.

0 = Standard page data

4 = Email beacon

20 = Custom data beacon

 limit

 integer

 Limits the number of rows returned.

 Max of 50,000 rows.

 page

 integer

 Which page currently being viewed if the rows of data pass the limit.

 order

 string or   array

 Orders the data by column. If used as an array, the "sort”   parameter must be in the same order as the “order”. For example:
 “order”:[“device”,pageHits”], “sort”:[“asc”,”desc”]
 In the above example, device will be in ascending order and   pageHits will be in descending order.

• time

• pageHits

• pageName

• country

• region

• trafficSeg

• browser

• os

• device

 sort

 string or   array

 Indicates whether the data is sorted by ascending or descending.

• asc

• desc

timezoneOffset

float

The number of hours before or after UTC to adjust epoch times by. Primarily applies when "time" is included in the request. Does not have any impact on the "start" or "end" epoch times in the request. For example, to convert the response data from the default UTC epoch times into the Pacific timezone, set timezoneOffset to -8.

appConnect

yes

App Connect time (ms)

basePageTime

yes

Base Page Time (ms)

browser

yes

yes

Browser

browserVersion

yes

yes

yes

Browser Version

connectStart

yes

yes

yes

Connect Start Time (epoch ms)

connectTime

yes

Connect Time (ms)

country

yes

yes

Country

csid

yes

yes

Customer Session ID

guid

yes

yes

Global User ID

userAgent

yes

yes

yes

User-Agent string

device

yes

yes

yes

Device

dns

yes

yes

yes

yes

DNS Time (ms)

dom

yes

yes

yes

DOM Complete (ms)

domContentLoadedStart

yes

yes

yes

DOM Content Loaded Start Time (epoch ms)

domContentLoadedEnd

yes

yes

yes

DOM Content Loaded End Time (epoch ms)

domainLookupStart

yes

yes

yes

Domain Lookup Start Time (epoch ms)

domInteractive

yes

yes

yes

DOM Interactive (epoch ms)

domLoading

yes

yes

yes

DOM Loading (epoch ms)

fetchStart

yes

yes

yes

Fetch Start Time (epoch ms)

firstByte

yes

yes

yes

First Byte Time (ms)

firstPaint

yes

yes

yes

First Paint Time (ms)

intToNextPaint

yes

yes

Interaction to Next Paint (milliseconds)

Reach out to your BT representative to find out if your site has been flipped to INP

loadEventStart

yes

yes

yes

Load Event Start Time (epoch ms)

measurementID

yes

yes

Measurement ID

measurementTime

yes

yes

yes

yes

Time of the Measurement (epoch ms)

navigationStart

yes

yes

yes

Navigation Start Time (epoch ms)

netspeed

yes

yes

Network Speed: 

• 0=Unknown

• 1=Dial-up

• 2=Cable/DSL

• 3=Corporate

• 4=Cellular

visitorType

yes

yes

Visitor Type: New=0, Return=1

onload

yes

yes

yes

Onload time (ms)

os

yes

yes

Operating System

trafficSeg

yes

yes

yes

yes

Traffic Segment

pageGroup

yes

yes

yes

yes

Page Group

pageName

yes

yes

yes

yes

Page Name

preTransfer

yes

Pre Transfer Time (ms)

redirect

yes

yes

yes

Total Redirect Time (ms)

redirectStart

yes

yes

yes

Redirect Start Time (epoch ms)

region

yes

yes

Region

agentLocation

yes

yes

Synthetic Agent Location

redirectTime

yes

Total Redirect Time (ms)

requestStart

yes

yes

yes

Request Start Time (epoch ms)

responseEnd

yes

yes

yes

Response End Time (epoch ms)

responseStart

yes

yes

yes

Response Start Time (epoch ms)

resourcesCaptured

yes

yes

"1" if resources were collected with that page view, "0" otherwise

secureConnectionStart

yes

yes

yes

Secure Connection Start (epoch ms)

sessionID

yes

yes

yes

BTT Session ID

startTransfer

yes

Start Transfer Time (ms)

tcp

yes

yes

yes

TCP Connect Time (ms)

totalBasePage

yes

Total Base Page Time (ms)

ssl

yes

yes

yes

SSL Time (ms)

sslExpireDate

yes

SSL Expiration Date

url

yes

yes

yes

yes

The page URL

httpCode

yes

yes

HTTP response code

video

yes

Whether a filmstrip is available

snapshot

yes

Whether a screenshot is  available

campaignSource

yes

yes

Campaign Source

trafficSource

yes

yes

Traffic Source

campaignMedium

yes

yes

Campaign Medium

trafficMedium

yes

yes

Traffic Medium

campaignName

yes

yes

Campaign Name

isp

yes

yes

Internet Service Provider (ISP)

abSegment

yes

yes

A/B Segment

datacenter

yes

yes

Data Center

elementCount

yes

Number of Elements

pageSize

yes

Page Size Uncompressed (bytes)

pageWireSize

yes

Page Size Compressed (bytes)

domainCount

yes

Number of Domains observed

imageBytes

yes

Sum of image size (bytes)

revenue

yes

yes

Revenue - if used, only data with revenue will return.

customerSession

yes

yes

customVariable1-5,

customVariable11-15

yes

yes

Custom Variables 1-10. 

customCategory1,

customCategory2,

...

customCategory5

yes

yes

Custom Categories 1-5

customNumber1,

customNumber2,

...

customNumber20

yes

yes

Custom Numbers 1-20

orderNumber

yes

yes

Order Number

orderId

yes

yes

Order ID

currencyCode

yes

yes

Currency Code

timeToInteractive

yes

yes

yes

Time to Interactive (ms)

fullyLoadedTime

yes

yes

Fully Loaded Time

fullyLoadedTimeHits
 

yes

yes

Fully Loaded Time Hits

firstContentfulPaint

yes

yes

yes

First Contentful Paint (ms)

consoleLog

yes

Whether a console log is available. 1=yes, 0=no

totalBytesDownloaded

yes

Total Bytes Downloaded (bytes)

requestHeaderSize

yes

Request Header Size (bytes)

responseHeaderSize

yes

Response Header Size (bytes)

contentLengthDownload

yes

Content Length Downloaded (bytes)

firstInputDelayStart

yes

yes

First Input Delay Start Time (ms)

firstInputDelayDuration

yes

yes

First Input Delay Duration (ms)

largestContentfulPaint

yes

yes

yes

Largest Contentful Paint (ms)

totalBlockingTime

yes

yes

yes

Total Blocking Time (ms)

cumulativeLayoutShiftEnd

yes

Cumulative Layout Shift End (ms)

cumulativeLayoutShift

yes

yes

Cumulative Layout Shift (ms)

speedIndex

yes

Speed Index

screenHeight

yes

Screen Height

LCPElementRenderDelayMS

yes

LCPElementRenderDelay (ms)

LCPElementRenderDelayPercentage

yes

LCPElementRenderDelay (%)

LCPTimeToFirstByteMS

yes

LCPTimeToFirstByte (ms)

LCPTimeToFirstBytePercentage

yes

LCPTimeToFirstByte (%)

LCPResourceDelayMS

yes

LCPResourceLoadDelay (ms)

LCPResourceLoadDelayPercentage

yes

LCPResourceLoadDelay (%)

LCPResourceLoadTimeMS

yes

LCPResourceLoadTime (ms)

LCPResourceLoadTimePercentage

yes

LCPResourceLoadTime (%)

LCPSelector

yes

LCP Selector

LCPURL

yes

LCP URL

CLSLargestShiftStart

yes

CLSLargestShiftStart (ms)

CLSLayoutShiftCount

yes

CLSLayoutShiftCount

CLSLargestShiftSelector

yes

CLSLargestShiftSelector

INPStart

yes

INPStart (ms)

INPInputDelay

yes

INP Input Delay (ms)

INPNextPaintTime

yes

INP Next Paint Time (ms)

INPProcessingDuration

yes

INP Processing Duration (ms)

INPPresentationDelay

yes

INP Presentation Delay (ms)

INPTargetSelector

yes

INPTargetSelector

INPEventType

yes

INP Event Type

INPTarget

yes

INPTarget

LOAFLongestScriptDuration

yes

LoAF Longest Script Duration (ms)

LOAFLongestScriptStart

yes

LoAF Longest Script Start (ms)

LOAFLongestScriptInvoker

yes

LOAFLongestScriptInvoker

LOAFLongestScriptSourceURL

yes

LOAFLongestScriptSourceURL