Queries

Build your own custom pixel load queries

The analytics page allows you to retrieve pixel load data with custom queries.

QueryDescriptionTypePossible Values
startStart timestampDate
endEnd timestampDate
metricsMetrics to retrieveArray of stringslightCount, darkCount, forwardCount, printCount, openCount, customCount
precisionPrecision of the dataStringsecond, minute, hour, day, month, year
whereAdditional queries to better refine results (See below)Array of Objects (see below)

Where

Where must be an array of objects, each containing the following keys:

KeyDescriptionTypePossible Values
facetstringpixelId, emailClients,renderingEngine,proxied,prefetched,country
operationstring=, !=
valueboolean (if facet is prefetched or proxied), otherwise an array of strings

Examples:

{
start: '2022-04-01',
end: '2022-06-31',
metrics: ['lightCount', 'darkCount'],
precision: 'day',
where: [
{
facet: 'country',
operation: '=',
value: ['US', 'CA']
}]
}
{
start: '2022-04-01 12:00:00',
end: '2022-04-05 12:15:00',
metrics: ['printCount', 'darkCount'],
precision: 'hour',
where: [
{
facet: 'pixelId',
operation: '=',
value: ['1s781p5qtm', '2sddnn3xdv']
}]
}
{
start: '2022-04-01 12:00:00',
end: '2022-04-01 18:15:00',
metrics: ['printCount', 'customCount', 'darkCount', 'forwardCount', 'openCount'],
precision: 'minute',
where: [
{
facet: 'proxied',
operation: '=',
value: true
}]
}
{
start: '2022-04-01 12:00:00',
end: '2022-04-01 18:15:00',
metrics: ['printCount', 'customCount', 'darkCount', 'forwardCount', 'openCount'],
precision: 'minute',
where: [
{
facet: 'proxied',
operation: '=',
value: true
}
{
facet: 'prefetched',
operation: '=',
value: false
}
{
facet: 'emailClients',
operation: '=',
value: ['MAC_CHROME']
}
]
}

If value is passed as an array, results that match any value in the array will be returned.

counts

countTypeDescription
lightCountNumber of times the pixel was loaded in the light state
darkCountNumber of times the pixel was loaded in the dark state
forwardCountNumber of times the pixel was loaded in the forward state
printCountNumber of times the pixel was loaded in the print state
openCountNumber of times the pixel was loaded in the open state
customCountNumber of times the pixel was loaded in the custom state

TODO IMPROVE THESE DESCRIPTIONS ^

emailClients

emailClientDescription
'GMAIL',
'GMAIL',
'YAHOO',
'APPLE*MAIL_PROTECTED',
'SUPERHUMAN',
'THUNDERBIRD',
'LOTUS_NOTES',
'AOL_DESKTOP',
'OUTLOOK_COM',
'OUTLOOK_2016',
'OUTLOOK_2013',
'OUTLOOK_2010',
'OUTLOOK_2007',
'OUTLOOK_2003',
'OUTLOOK_IOS',
'SAMSUNG_MAIL',
'APPLE_MAIL',
'POSTBOX',
'IPHONE',
'IPAD',
'ANDROID',
'BLACKBERRY',
'WINDOWS_PHONE',
WINDOWS*${parsedUserAgent?.browser?.name.toUpperCase()},
MAC_${parsedUserAgent?.browser?.name.toUpperCase()},
'BOT',
null,

renderingEngine

renderingEngineDescription
'BLINK'
'WORD'
'WEBKIT'
null

TODO THERE ARE MANY MORE POSSIBLE HERE ^

country

Countries are stored as two letter ISO 3166-1 alpha-2 codes.