Metrics (Common)

AMALYZE Falcon API

Metrics Object

Request

Specifies the required metrics to be returned. See table below for valid values.

This example will return impressions, clicks, salesOtherSKU30D, unitsPerConversionAllSKU30D

Sorting Object

Request

Specifies the (metric) colums and directions to be sorted for. See table below for valid values.

This example will sort by impressions in descending order

Filter Object

Request

Specifies the (metric) filters to be applied. See table below for valid values.

"filters": {
   "impressions": [
      {
         "op": "gte",
         "value": 1
      },
      {
         "op": "lte",
         "value": 1000
      }
   ],
   "clicks": [
      {
         "op": "gte",
         "value": 100
      }
   ]
}

"filters": {

"impressions": [

{

"op": "gte",

"value": 1

{

"op": "lte",

"value": 1000

}

"clicks": [

{

"op": "gte",

"value": 100

}

]

}

This example will return only entries having impressions >= 1 && impressions <= 1000 && clicks >= 100

Property	Description	Comment
`impressions`	Total ad impressions	since 0.1.14
`clicks`	Total ad clicks	since 0.1.14
`cost`	Total cost of all clicks	since 0.1.14
`clickThroughRate`	`ctr = clicks / impressions`	since 0.1.14
`costPerClick`	`cpc: cost / clicks`	since 0.1.14
`costPerMille`	`cpm = cost / (impressions / 1000 )`	since 0.1.14
`salesAllSKU1D` `salesAllSKU7D` `salesAllSKU14D` `salesAllSKU30D`	Number of attributed sales occurring within 1,7,14 and 30 day(s) of click on ad.	since 0.1.14
`salesSameSKU1D` `salesSameSKU7D` `salesSameSKU14D` `salesSameSKU30D`	Aggregate value of attributed sales occurring within 1,7,14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised.	since 0.1.14
`conversionsAllSKU1D` `conversionsAllSKU7D` `conversionsAllSKU14D` `conversionsAllSKU30D`	Number of attributed conversion events occurring within 1, 7, 14 and 30 day(s) of click on ad.	since 0.1.14
`conversionsSameSKU1D` `conversionsSameSKU7D` `conversionsSameSKU14D` `conversionsSameSKU30D`	Number of attributed conversion events occurring within 1, 7, 14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised.	since 0.1.14
`unitsAllSKU1D` `unitsAllSKU7D` `unitsAllSKU14D` `unitsAllSKU30D`	Number of attributed units ordered within 1, 7, 14 and 30 day(s) of click on ad.	since 0.1.14
`costPerConversionAllSKU1D` `costPerConversionAllSKU7D` `costPerConversionAllSKU14D` `costPerConversionAllSKU30D`	Average cost per attributed conversion events occuring within 1,7,14 and 30 days of click on ad `cpcr = cost / conversions`	since 0.1.14
`costPerConversionSameSKU1D` `costPerConversionSameSKU7D` `costPerConversionSameSKU14D` `costPerConversionSameSKU30D`	Average cost per attributed conversion events occuring within 1,7,14 and 30 days of click on ad where the purchased SKU was the same as the one advertised `cpcr = cost / conversions`	since 0.1.14
`salesPerConversionAllSKU1D` `salesPerConversionAllSKU7D` `salesPerConversionAllSKU14D` `salesPerConversionAllSKU30D`	Average sales / revenue per attributed conversion events occuring within 1,7,14 and 30 days of click on ad `spcr = sales / conversions`	since 0.1.14
`salesPerConversionSameSKU1D` `salesPerConversionSameSKU7D` `salesPerConversionSameSKU14D` `salesPerConversionSameSKU30D`	Average sales / revenue per attributed conversion events occuring within 1,7,14 and 30 days of click on ad where the purchased SKU was the same as the one advertised `spcr = sales / conversions`	since 0.1.14
`costPerUnitAllSKU1D` `costPerUnitAllSKU7D` `costPerUnitAllSKU14D` `costPerUnitAllSKU30D`	Average cost per attributed units ordered within 1,7,14 and 30 days of click on ad `cpu = cost / units`	since 0.1.14
`salesPerUnitAllSKU1D` `salesPerUnitAllSKU7D` `salesPerUnitAllSKU14D` `salesPerUnitAllSKU30D`	Average cost per attributed units ordered within 1, 7, 14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `cpu = sales / units`	since 0.1.14
`conversionRateAllSKU1D` `conversionRateAllSKU7D` `conversionRateAllSKU14D` `conversionRateAllSKU30D`	Average conversion rate per attributed conversion events occuring within 1, 7, 14 and 30 day(s) of click on ad `cr = conversions / clicks`	since 0.1.14
`conversionRateSameSKU1D` `conversionRateSameSKU7D` `conversionRateSameSKU14D` `conversionRateSameSKU30D`	Average conversion rate per attributed conversion events occuring within 1, 7, 14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `cr = conversions / clicks`	since 0.1.14
`acosAllSKU1D` `acosAllSKU7D` `acosAllSKU14D` `acosAllSKU30D`	Advertising cost of sale per atributed conversion event occuring within 1,7,14 and 30 day(s) of click on ad `acos = cost / sales`	since 0.1.14
`acosSameSKU1D` `acosSameSKU7D` `acosSameSKU14D` `acosSameSKU30D`	Advertising cost of sale per atributed conversion event occuring within 1,7,14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `acos = cost / sales`	since 0.1.14
`roasAllSKU1D` `roasAllSKU7D` `roasAllSKU14D` `roasAllSKU30D`	Return on advertising spend per atributed conversion event occuring within 1,7,14 and 30 day(s) of click on ad `roas = sales / cost`	since 0.1.14
`roasSameSKU1D` `roasSameSKU7D` `roasSameSKU14D` `roasSameSKU30D`	Return on advertising spend per atributed conversion event occuring within 1,7,14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `roas = sales / cost`	since 0.1.14
`salesPerMilleAllSKU1D` `salesPerMilleAllSKU7D` `salesPerMilleAllSKU14D` `salesPerMilleAllSKU30D`	Average sales / revenues per thousand impressions per attributed sales occuring within 1,7,14 and 30 day(s) of click on ad `spm = sales / (impressions / 1000)`	since 0.1.14
`salesPerMilleSameSKU1D` `salesPerMilleSameSKU7D` `salesPerMilleSameSKU14D` `salesPerMilleSameSKU30D`	Average sales / revenues per thousand impressions per attributed sales occuring within 1,7,14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `spm = sales / (impressions / 1000)`	since 0.1.14
`conversionsPerMilleAllSKU1D` `conversionsPerMilleAllSKU7D` `conversionsPerMilleAllSKU14D` `conversionsPerMilleAllSKU30D`	Average conversions per thousand impressions per attributed sales occuring within 1,7,14 and 30 day(s) of click on ad `cvpm = conversions / (impressions / 1000)`	since 0.1.14
`conversionsPerMilleSameSKU1D` `conversionsPerMilleSameSKU7D` `conversionsPerMilleSameSKU14D` `conversionsPerMilleSameSKU30D`	Average conversions per thousand impressions per attributed sales occuring within 1,7,14 and 30 day(s) of click on ad where the purchased SKU was the same as the one advertised `cvpm = conversions / (impressions / 1000)`	since 0.1.14
`unitsPerConversionAllSKU1D` `unitsPerConversionAllSKU7D` `unitsPerConversionAllSKU14D` `unitsPerConversionAllSKU30D`	Average units per attributed conversion events occuring 1,7,14 and 30 day(s) of click on ad `upc = units / conversions`	since 0.1.14