personalizer.io Documentation

Help Page Home

POST marketing/v1/CampaignStatistics?Date={Date}&Day={Day}&DayOfWeek={DayOfWeek}&DayOfYear={DayOfYear}&Hour={Hour}&Kind={Kind}&Millisecond={Millisecond}&Minute={Minute}&Month={Month}&Now={Now}&UtcNow={UtcNow}&Second={Second}&Ticks={Ticks}&TimeOfDay={TimeOfDay}&Today={Today}&Year={Year}&toDate={toDate}&fields={fields}

Request Information

URI Parameters

NameTypeDescriptionComments
fromDate date

toDate date

fields string

Body Parameters

Collection of globally unique identifier

Request Formats

application/json, text/json

Sample:
[
  "28cc67b2-71ea-4628-9d77-fcba25b71504",
  "3401910f-471e-4e6d-ac79-57d3290fdeff"
]

Response Information

Resource Description

Collection of CampaignStatistics
NameTypeDescriptionComments
SubscriberID integer

Date date

CampaignGuid globally unique identifier

CampaignEntryGuid globally unique identifier

TotalCampaignRenderCount integer

TotalCampaignLandCount integer

TotalItemViewCount integer

TotalItemTimeSpendSum integer

TotalProductVariantAddToCartCount integer

TotalProductVariantPurchaseCount integer

TotalProductVariantRevenueAmount decimal number

TotalProductVariantRefundCount integer

TotalProductVariantRefundAmount decimal number

TotalProductVariantDiscountAmount decimal number

TotalProductVariantTaxAmount decimal number

TotalProductVariantTaxRefundAmount decimal number

TotalOrderCount integer

TotalOrderCancellationCount integer

TotalOrderShippingAmount decimal number

TotalCustomEventCount integer

TotalCustomEventAmount decimal number

TotalCustomEventEventCount integer

Response Formats

application/json, text/json

Sample:
[
  {
    "SubscriberID": 1,
    "Date": "2021-09-27T04:34:59.049892+00:00",
    "CampaignGuid": "0b00c4c2-6b4c-4174-9f57-d6c843d9b3d0",
    "CampaignEntryGuid": "399fbcf0-5e04-4a73-81f3-170454c48dd7",
    "TotalCampaignRenderCount": 1,
    "TotalCampaignLandCount": 1,
    "TotalItemViewCount": 1,
    "TotalItemTimeSpendSum": 1,
    "TotalProductVariantAddToCartCount": 1,
    "TotalProductVariantPurchaseCount": 1,
    "TotalProductVariantRevenueAmount": 1.0,
    "TotalProductVariantRefundCount": 1,
    "TotalProductVariantRefundAmount": 1.0,
    "TotalProductVariantDiscountAmount": 1.0,
    "TotalProductVariantTaxAmount": 1.0,
    "TotalProductVariantTaxRefundAmount": 1.0,
    "TotalOrderCount": 1,
    "TotalOrderCancellationCount": 1,
    "TotalOrderShippingAmount": 1.0,
    "TotalCustomEventCount": 1,
    "TotalCustomEventAmount": 1.0,
    "TotalCustomEventEventCount": 1
  },
  {
    "SubscriberID": 1,
    "Date": "2021-09-27T04:34:59.049892+00:00",
    "CampaignGuid": "0b00c4c2-6b4c-4174-9f57-d6c843d9b3d0",
    "CampaignEntryGuid": "399fbcf0-5e04-4a73-81f3-170454c48dd7",
    "TotalCampaignRenderCount": 1,
    "TotalCampaignLandCount": 1,
    "TotalItemViewCount": 1,
    "TotalItemTimeSpendSum": 1,
    "TotalProductVariantAddToCartCount": 1,
    "TotalProductVariantPurchaseCount": 1,
    "TotalProductVariantRevenueAmount": 1.0,
    "TotalProductVariantRefundCount": 1,
    "TotalProductVariantRefundAmount": 1.0,
    "TotalProductVariantDiscountAmount": 1.0,
    "TotalProductVariantTaxAmount": 1.0,
    "TotalProductVariantTaxRefundAmount": 1.0,
    "TotalOrderCount": 1,
    "TotalOrderCancellationCount": 1,
    "TotalOrderShippingAmount": 1.0,
    "TotalCustomEventCount": 1,
    "TotalCustomEventAmount": 1.0,
    "TotalCustomEventEventCount": 1
  }
]