Queries

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

Query	Description	Type	Possible Values
start	Start timestamp	Date
end	End timestamp	Date
metrics	Metrics to retrieve	Array of strings	lightCount, darkCount, forwardCount, printCount, openCount, customCount
precision	Precision of the data	String	second, minute, hour, day, month, year
where	Additional 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:

Key	Type	Possible Values
facet	string	pixelId, emailClients,renderingEngine,proxied,prefetched,country
operation	string	=, !=
value	boolean (if facet is prefetched or proxied), otherwise an array of strings	true, false |

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

countType	Description
lightCount	Number of times the pixel was loaded in the light state
darkCount	Number of times the pixel was loaded in the dark state
forwardCount	Number of times the pixel was loaded in the forward state
printCount	Number of times the pixel was loaded in the print state
openCount	Number of times the pixel was loaded in the open state
customCount	Number of times the pixel was loaded in the custom state

TODO IMPROVE THESE DESCRIPTIONS ^

emailClients

emailClient
'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

renderingEngine
'BLINK'
'WORD'
'WEBKIT'
null

country

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