Required Parameters
|
Names |
Type |
Description |
Options/Constraints |
|---|---|---|---|
|
site |
string |
The site in Blue Triangle to run this monitor/instant measurement under. Uses the unique ID associated with your tag. |
|
|
start |
integer |
The start of the time period over which to list the reports. |
epoch seconds |
|
end |
integer |
The end of the time period over which to list the reports. |
epoch seconds |
|
datatype |
string |
If data is native app or RUM. Defaults to “rum”. |
|
|
dataColumns |
array |
The data columns to be retrieved. |
Options and descriptions listed below. |
|
group |
array |
If grouping by time, bucketSize will be available. |
Limited to 3 columns. |
Data Column Options
|
Data Column Name |
Description |
|---|---|
|
time |
Time |
|
onload |
Onload time (milliseconds) |
|
avgSales |
|
|
conversionRate |
|
|
bounceRate |
|
|
pageHits |
Total number of page views |
|
revenue |
Revenue amount |
|
brand |
|
|
conversions |
|
|
orders |
Total orders |
|
brandConversions |
|
|
brandOrders |
|
|
visitors |
Total visitors (sessions) |
|
bounceCount |
|
|
nonBounceCount |
|
|
exitCount |
|
|
exitRate |
|
|
customVariables(1-5; 11-15) |
Configurable variable for data collection use. See Using Custom Variables. |
Grouping Column Options
|
Column Name |
Description |
Value |
|---|---|---|
|
pageHits |
Total number of page views. |
|
|
time |
Time. |
|
|
onload |
Onload time (milliseconds). |
|
|
sessionID |
RUM or Synthetic session ID. |
|
|
pageName |
Groups data by page name |
|
|
pageGroup |
Groups data by page group. |
|
|
trafficSeg |
Groups data by traffic segment. |
|
|
country |
Groups data by country. |
ISO 3166 format |
|
region |
Groups data by region. |
ISO 3166 format with region ID numbers |
|
browserVersion |
Groups data by browser version. |
|
|
browser |
Groups data by browser. |
|
|
os |
Groups data by operating system. |
|
|
device |
Groups data by device. |
|
|
netspeed |
Groups data by netspeed. |
|
|
campaignSource |
Groups data by campaign source. |
|
|
campaignName |
Groups data by campaign name. |
|
|
isp |
Groups data by Internet Service Provider (ISP). |
|
|
abSegment |
Groups data by an A/B Segment. |
|
|
datacenter |
Groups data by data center. |
|
|
campaignMedium |
Groups data by traffic medium. |
|
|
visitorType |
Groups data by visitor type. Defaults to include both. |
|
|
netState |
Groups data by net state. |
|
|
screenType |
Groups data by screen type. |
|
|
numberOfCPUCores |
Groups data by the number of CPU cores. |
|
|
deviceModel |
Groups data by device model. |
|
|
osVersion |
Groups data by operating system version. |
|
|
appVersion |
Groups data by app version. |
|
|
version |
Groups data by version. |
|
|
customVar6–customVar10 |
Groups data by custom variable. See Using Custom Variables. |
|
|
customCategory1–customCategory5 |
Groups data by custom variable. See Using Custom Variables. |
|
Parameter Filters
|
Key |
|
|
|
|---|---|---|---|
|
limit |
|
|
|
|
salesType: sales or brand |
|
|
|
|
timezoneOffset |
|
|
|
|
performanceMetric (this is what changes the metric publicly; ttDomCont, ttDomInt, tti, lcp, inp/fid, cls) |
|
|
|
|
order |
|
|
|
|
sort |
|
|
|
|
trafficSeg |
|
|
|
|
isp |
|
|
|
|
campaignName |
|
|
|
|
campaignSource |
|
|
|
|
campaignMedium |
|
|
|
|
pageName: only one at a time |
|
|
|
|
pageGroup |
|
|
|
|
country/ region |
|
|
|
|
browser / browserVersion |
|
|
|
|
os |
|
|
|
|
device |
|
|
|
|
abSegment |
|
|
|
|
origin |
|
|
|
|
excluded |
|
|
|
|
botTraffic (same as excluded, will make this one pubic) |
|
|
|
|
minPageLoad / maxPageLoad |
|
|
|
|
deviceModel (native only) |
|
|
|
|
version (native only) |
|
|
|
|
osVersion (native only) |
|
|
|
|
appVersion (native only) |
|
|
|
|
netspeed(native only) |
|
|
|
|
visitorType |
|
|
|