{"openapi":"3.0.0","info":{"title":"Reports API","description":"Provides access to reporting data for a Dotdigital Personalization website or account. Reports cover campaign performance, conversion rates, abandoned and recovered carts, customer behaviour, and revenue attribution. Use this API to pull structured report data for integration with business intelligence tools or custom dashboards. Covers summary and detailed campaign reports, conversion reports, cart recovery reports, and additional engagement metrics.","version":"1.0.1"},"servers":[{"url":"https://{region}-api-freshrelevance.dotdigital.com/api","variables":{"region":{"description":"The region id your account belongs to","enum":["r1","r2","r3"],"default":"r1"}}}],"security":[{"apiTokenAuth":[]}],"paths":{"/{website_id}/campaigns/":{"get":{"tags":["Campaigns"],"summary":"Campaigns summary report","description":"Retrieves a summary report of campaings executed in the given time range for the requesting account and website. Note the system uses next day attribution to collate this data.","operationId":"getCampaignsReport","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in this format.","schema":{"type":"string","enum":["json","csv"],"default":"json"},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200"},"examples":{"success":{"value":{"results":[{"purchased_p":115894.00999564635,"lv":0,"purchased_q":2262,"abandoned_p":235644.52964724007,"abandoned_q":62,"fmt_purchased_q":"2,260","fmt_purchased_p":"116,000","fmt_assisted_q":"0","fmt_assisted_p":"0","fmt_abandoned_q":"62","fmt_abandoned_p":"236,000","fmt_v":"0.00","fmt_cp":"0.00","products":"","tmti_text":"","attributions":{},"last_click":"Campaign"}],"total":1}}}},"text/csv":{"example":"Campaign,Impressions,On-site Purchase Count,On-site Value,Off-site Purchase Count,Off-site Value,Abandoned,Abandoned Value,Type,Errors\n,,0.0,0.0,2260.0,116000.0,62.0,236000.0,,\n"}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/campaigns_details/":{"get":{"tags":["Campaigns"],"summary":"Campaigns details report","description":"Retrieves details each conversion campaigns have generated in the given time range for the requesting account and website. Note the system uses click attribution to collate this data.","operationId":"getCampaignsDetailsReport","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in this format.","schema":{"type":"string","enum":["json","csv"],"default":"json"},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_1"},"examples":{"success":{"value":{"results":[{"_id":"6551fca51e8cbe6f97e89a5f","o_num":"#3314","assists":[{"assv":582.36594,"assw":1}],"attributions":[{"attv":582.36594,"attw":1},{"attv":582.36594,"attw":1}],"cart":{"p":[{"_id":"7wZijh-32gC3lQb7SgUVLw==","n":"Antler Flying V","prid":"5354137682087","img":"https://experiencedemo.myshopify.com/cdn/shop/products/10705102000575_1_292x720_72_RGB_1024x1024@2x.jpg?v=1592558637","u":"https://experiencedemo.myshopify.com/products/burton-antler-flying-v-snowboard-2016#34795891425447","desc":"\n          This is a demonstration store. You can purchase products like this from The Ski Chalet & Treasure Cove Scuba.\nBEND: Flying V™\nSHAPE: Directional\nFLEX: Twin\nCORE: FSC™ Certified Dragonfly™ 600G Core with Multizone EGD™ and Squeezebox High\nFIBERGLASS: 60° Carbon Highlights Hi-Voltage\nBASE: Sintered WFO\nFEATURES: The Channel™, Frostbite Edges, Scoop, Full Length Guard Rails, Pro-Tip™, and Infinite Ride™\nARTIST: Tom French [www.tomfrenchart.com]\nKEY FEATURE: English artist Tom French literally blurs the lines between realism and surrealism, abstract and figurative, beautiful and frightening. French’s Antler graphics layer subjects and meaning into a dark and compelling visual narrative.  \n\n        ","sbr":"experiencedemo","variants":{"34795891425447":{"img":"https://experiencedemo.myshopify.com/cdn/shop/products/10705102000575_1_292x720_72_RGB_1024x1024@2x.jpg?v=1592558637","vid":"34795891425447","u":"https://experiencedemo.myshopify.com/products/burton-antler-flying-v-snowboard-2016#34795891425447","stock":8,"dt":"2023-11-13T10:36:04.326000+00:00","related":[{"_id":"M1ECb-pJyTstUm45mO9FRg==","vid":"34795710742695"},{"_id":"BNFGfZXEpqMzFmA3ApdlCQ==","vid":"34795787649191"},"7xSOTqp66rUSfsNAwycraA=="],"uv":871,"up":"$871.00","ruv":871,"rup":"$871.00"}},"ex":{"shopify_alt_images":[{"src":"https://cdn.shopify.com/s/files/1/0411/6312/8999/products/10705102000575_1_292x720_72_RGB.jpg?v=1592558637","variant_ids":[34795891425447]}],"test":"test value","colour":"rainbow","n":"157.5cm","Size":"157.5cm"},"stock":8,"variant_array":[{"vid":"34795891425447","cat":["size:157-5cm","collection:home-page","collection:smart-collection"],"ex":{"n":"157.5cm","Size":"157.5cm"},"stock":8,"uv":871,"ruv":871,"img":true,"u":true},{"cat":["size:157-5cm","collection:home-page","collection:smart-collection"]}],"cat":[{"g":"Size","n":"157.5cm","s":true,"catid":"size:157-5cm","gid":"size","dt":"2023-11-13T10:38:29.149000+00:00","r":false,"v":true,"_id":"size:157-5cm"},{"g":"Collection","n":"Home page","s":true,"catid":"collection:home-page","gid":"collection","dt":"2023-11-13T10:38:29.149000+00:00","r":false,"v":true,"_id":"collection:home-page"},{"g":"Collection","n":"Smart COllection","s":true,"catid":"collection:smart-collection","gid":"collection","dt":"2023-11-13T10:38:29.149000+00:00","r":false,"v":true,"_id":"collection:smart-collection"}],"dt":"2023-11-13T10:36:04.326000+00:00","edt":"2023-12-13T10:36:05.483000+00:00","dtadded":"2023-01-11T13:46:05.292000+00:00","ai":{"meta":{"uv_scaled":0.3890765765765765,"uv_z":1.8920850785258037,"uv":870.66},"updated":"2023-11-13T02:00:45.772000+00:00","uv_thirds":2,"uv_thirds_sorted_price":2,"uv_bq_thirds":2,"uv_ex_outliers":2},"qty":1,"vid":"34795891425447","opt":{"shopify":{}},"curr":"USD","uv":871,"up":"$871.00","ruv":871,"rup":"$871.00"}],"qty":1,"sbr":"experiencedemo","cv":712.2,"curr":"USD","cart_id":"d6b1ac4ecfddf4b9b16d7d67231469bc","dt":"2023-11-13T10:35:20+00:00","pdt":"2023-11-13T10:35:20+00:00"},"dt":"2023-11-13T10:35:20+00:00","email":"joe.bloggs@emailsim.io","pid":"64f7201acdcc769e9dd09a2f","q":{},"v":582.36594,"assist_tmsb":"","attribute_tmsb":"","fmt_purchased_q":"0.0","fmt_purchased_p":"0.0","fmt_assisted_q":"0.0","fmt_assisted_p":"0.0","fmt_abandoned_q":"0.0","fmt_abandoned_p":"0.0","fmt_v":"582.37","fmt_cp":"0.00","products":"Antler Flying V at $871.00","product_0_prid":"5354137682087","product_0_n":"Antler Flying V","product_0_uv":"871.00","product_0_qty":"1","tmti_text":"","last_click":"Campaign"}],"count":2262}}}},"text/csv":{"example":"Email,Date,Products,Value,Local Value,Campaign,Order Number,Source,Link,Layout Clicked,Trigger Clicked,Stage,Slot,On-site SmartBlock,Off-site SmartBlock,Last Click\nhester.lyons+dollartest@freshrelevance.com,2024-04-23 13:00:02.352000+00:00,\"Dawson Trolley at €327.89\nDeath Falcon at $396.06\",723.95,624.45,,bc6ac0f70c,,,,,,,,,Campaign\n"}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/conversions/":{"get":{"tags":["Conversions"],"summary":"Conversions report","description":"Retrieves a daily summary report of conversions in the given time range for the requesting account and website.","operationId":"getConversionsReport","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in this format.","schema":{"type":"string","enum":["json","csv"],"default":"json"},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_2"},"examples":{"success":{"value":{"results":[{"_id":{"day_of_year":[1,2025]},"b_p_i":0,"b_p_ni":0,"b_q_i":0,"b_q_ni":0,"ba_q_i":0,"ba_q_ni":0,"cu_q_i":0,"cu_q_ni":0,"ms_q":0,"ms_b_q":0,"ms_ba_q":0,"ms_cu_q":0,"ms_pcv_q":0,"ms_pcs_q":0,"ms_pcls_q":0,"rec_q":0,"rec_p":0,"p_q":0,"p_p":0,"pv":0,"sq":0,"cspv":787,"ms_ca_b_q":0,"ms_ca_ba_q":0,"ms_pcv_cu_q":0,"ms_pcs_cu_q":0,"rec_b_p":0,"rec_cu_p":0,"rec_ba_p":0,"rec_t_p":0,"rec_pcv_p":0,"rec_pcs_p":0,"rec_pcls_p":0,"rec_b_q":0,"rec_ba_q":0,"rec_cu_q":0,"rec_pcv_q":0,"rec_pcs_q":0,"rec_pcls_q":0,"count":361,"dt":"2025-01-01T00:00:00+00:00","imp":9,"ct":0,"sb_p_q":0,"sb_p_p":0,"as_p_q":0,"as_p_p":0,"at_p_q":0,"at_p_p":0,"recovered":{"count":0,"value":0},"purchased":{"count":0,"value":0},"abandoned":{"count":0,"value":0},"fmt_dt":"2025-01-01","fmt_sales_uplift":"0.0%","fmt_purchased_rate":"0.0%","fmt_recovered_rate":"0.0%","fmt_abv_purchased":"0","fmt_abv_abandoned":"0","fmt_abv_recovered":"0","fmt_p_q":"0","fmt_p_p":"0","fmt_b_q":"0","fmt_b_p":"0","fmt_rec_q":"0","fmt_rec_p":"0","fmt_rec_b_q":"0","fmt_rec_b_p":"0","fmt_rec_ba_q":"0","fmt_rec_ba_p":"0","fmt_rec_cu_q":"0","fmt_rec_cu_p":"0","fmt_rec_pcv_q":"0","fmt_rec_pcv_p":"0","fmt_rec_pcs_q":"0","fmt_rec_pcs_p":"0","fmt_percent_abandoned":"0.0%","fmt_percent_abandoned_all_sessions":"0.0%","fmt_percent_recovered":"0.0%","fmt_ms_b_q":"0","fmt_b_identification_rate":"0.0%","ba_q":0,"fmt_ba_q":"0","fmt_ba_identification_rate":"0.0%","fmt_ms_ba_q":"0","fmt_ms_cu_q":"0","fmt_ms_pcv_q":"0","fmt_ms_pcs_q":"0","fmt_ms_q":"0","fmt_pv":"0","fmt_sq":"0","fmt_pq_conversion_rate":"0.0%","fmt_cspv":"787","tpv":787,"fmt_tpv":"787","fmt_ms_ca_b_q":"0","fmt_ms_ca_ba_q":"0","fmt_ms_ca_cu_q":"0","fmt_ms_ca_pcv_q":"0","fmt_ms_ca_pcs_q":"0","fmt_imp":"9","fmt_ct":"0","fmt_as_p_q":"0","fmt_as_p_p":"0","fmt_at_p_q":"0","fmt_at_p_p":"0"},{"_id":{"day_of_year":[12,2024]},"b_p_i":0,"b_p_ni":955.7391775197752,"b_q_i":0,"b_q_ni":11,"ba_q_i":0,"ba_q_ni":6,"cu_q_i":0,"cu_q_ni":0,"ms_q":0,"ms_b_q":0,"ms_ba_q":0,"ms_cu_q":0,"ms_pcv_q":0,"ms_pcs_q":0,"ms_pcls_q":0,"rec_q":0,"rec_p":0,"p_q":0,"p_p":0,"pv":54,"sq":39,"cspv":16807,"ms_ca_b_q":0,"ms_ca_ba_q":0,"ms_pcv_cu_q":0,"ms_pcs_cu_q":0,"rec_b_p":0,"rec_cu_p":0,"rec_ba_p":0,"rec_t_p":0,"rec_pcv_p":0,"rec_pcs_p":0,"rec_pcls_p":0,"rec_b_q":0,"rec_ba_q":0,"rec_cu_q":0,"rec_pcv_q":0,"rec_pcs_q":0,"rec_pcls_q":0,"count":5059,"dt":"2024-12-01T00:00:00+00:00","imp":649,"ct":20,"sb_p_q":0,"sb_p_p":0,"as_p_q":0,"as_p_p":0,"at_p_q":0,"at_p_p":0,"recovered":{"count":0,"value":0},"purchased":{"count":0,"value":0},"abandoned":{"count":11,"value":955.7391775197752},"fmt_dt":"2024-12-01","fmt_sales_uplift":"0.0%","fmt_purchased_rate":"0.0%","fmt_recovered_rate":"0.0%","fmt_abv_purchased":"0","fmt_abv_abandoned":"86","fmt_abv_recovered":"0","fmt_p_q":"0","fmt_p_p":"0","fmt_b_q":"11","fmt_b_p":"956","fmt_rec_q":"0","fmt_rec_p":"0","fmt_rec_b_q":"0","fmt_rec_b_p":"0","fmt_rec_ba_q":"0","fmt_rec_ba_p":"0","fmt_rec_cu_q":"0","fmt_rec_cu_p":"0","fmt_rec_pcv_q":"0","fmt_rec_pcv_p":"0","fmt_rec_pcs_q":"0","fmt_rec_pcs_p":"0","fmt_percent_abandoned":"100.0%","fmt_percent_abandoned_all_sessions":"28.2%","fmt_percent_recovered":"0.0%","fmt_ms_b_q":"0","fmt_b_identification_rate":"0.0%","ba_q":6,"fmt_ba_q":"6","fmt_ba_identification_rate":"0.0%","fmt_ms_ba_q":"0","fmt_ms_cu_q":"0","fmt_ms_pcv_q":"0","fmt_ms_pcs_q":"0","fmt_ms_q":"0","fmt_pv":"54","fmt_sq":"39","fmt_pq_conversion_rate":"0.0%","fmt_cspv":"16,800","tpv":16861,"fmt_tpv":"16,900","fmt_ms_ca_b_q":"0","fmt_ms_ca_ba_q":"0","fmt_ms_ca_cu_q":"0","fmt_ms_ca_pcv_q":"0","fmt_ms_ca_pcs_q":"0","fmt_imp":"649","fmt_ct":"20","fmt_as_p_q":"0","fmt_as_p_p":"0","fmt_at_p_q":"0","fmt_at_p_p":"0"}],"total":57,"oColumnTotals":{"b_p_i":88880.64866207125,"b_p_ni":208020.04888015537,"b_q_i":322,"b_q_ni":841,"ba_q_i":1024,"ba_q_ni":2193,"cu_q_i":120,"cu_q_ni":90,"ms_q":648,"ms_b_q":243,"ms_ba_q":190,"ms_cu_q":11,"ms_pcv_q":9,"ms_pcs_q":0,"ms_pcls_q":0,"rec_q":4,"rec_p":282,"p_q":2309,"p_p":227857.2699912928,"pv":65394,"sq":44435,"cspv":1075921,"ms_ca_b_q":3,"ms_ca_ba_q":6,"ms_pcv_cu_q":0,"ms_pcs_cu_q":0,"rec_b_p":252,"rec_cu_p":0,"rec_ba_p":30,"rec_t_p":0,"rec_pcv_p":0,"rec_pcs_p":0,"rec_pcls_p":0,"rec_b_q":3,"rec_ba_q":1,"rec_cu_q":0,"rec_pcv_q":0,"rec_pcs_q":0,"rec_pcls_q":0,"count":213086,"imp":253383,"ct":3084,"sb_p_q":0,"sb_p_p":0,"as_p_q":53,"as_p_p":2847.85,"at_p_q":2,"at_p_p":118,"recovered":{"count":4,"value":282},"purchased":{"count":2309,"value":227857.2699912928},"abandoned":{"count":1163,"value":296900.69754222664},"fmt_sales_uplift":"0.1%","fmt_purchased_rate":"43.4%","fmt_recovered_rate":"0.1%","fmt_abv_purchased":"98","fmt_abv_abandoned":"255","fmt_abv_recovered":"70","fmt_p_q":"2,310","fmt_p_p":"228,000","fmt_b_q":"1,160","fmt_b_p":"297,000","fmt_rec_q":"4","fmt_rec_p":"282","fmt_rec_b_q":"3","fmt_rec_b_p":"252","fmt_rec_ba_q":"1","fmt_rec_ba_p":"30","fmt_rec_cu_q":"0","fmt_rec_cu_p":"0","fmt_rec_pcv_q":"0","fmt_rec_pcv_p":"0","fmt_rec_pcs_q":"0","fmt_rec_pcs_p":"0","fmt_percent_abandoned":"33.5%","fmt_percent_abandoned_all_sessions":"3.3%","fmt_percent_recovered":"0.3%","fmt_ms_b_q":"243","fmt_b_identification_rate":"27.7%","ba_q":3217,"fmt_ba_q":"3,220","fmt_ba_identification_rate":"31.8%","fmt_ms_ba_q":"190","fmt_ms_cu_q":"11","fmt_ms_pcv_q":"9","fmt_ms_pcs_q":"0","fmt_ms_q":"648","fmt_pv":"65,400","fmt_sq":"44,400","fmt_pq_conversion_rate":"5.2%","fmt_cspv":"1,080,000","tpv":1141315,"fmt_tpv":"1,140,000","fmt_ms_ca_b_q":"3","fmt_ms_ca_ba_q":"6","fmt_ms_ca_cu_q":"0","fmt_ms_ca_pcv_q":"0","fmt_ms_ca_pcs_q":"0","fmt_imp":"253,000","fmt_ct":"3084.0","fmt_as_p_q":"53","fmt_as_p_p":"2,850","fmt_at_p_q":"2","fmt_at_p_p":"118"}}}}},"text/csv":{"example":"Date,Sessions,Number Purchased,Conversion Rate,Sales uplift (triggers),Purchased Rate,Recovered Rate,ABV Purchased,ABV Abandoned,ABV Recovered,Value Purchased,Carts Abandoned,Value Abandoned,Number Recovered,Value Recovered,Number Recovered from Cart Abandon,Value Recovered from Cart Abandon,Number Recovered from Browse Abandon,Value Recovered from Browse Abandon,Percent Abandoned,Percent Recovered,Cart Abandon Emails Sent,Cart Abandon Identification Rate,Number Browse Abandon,Browse Abandon Identification Rate,Browse Abandon Emails Sent,Emails Sent,Page Views,Personalised Content Views,Total Page Views,Catch-All Cart Abandon Sent,Catch-All Browse Abandon Sent,Dynamic SmartBlock Impressions,SmartBlock Assisted Purchase Count,SmartBlock Assisted Purchase Value,SmartBlock Off-site Purchase Count,SmartBlock Off-site Purchase Value\n2025-01-01,0,0,0.0%,0.0%,0.0%,0.0%,0,0,0,0,0,0,0,0,0,0,0,0,0.0%,0.0%,0,0.0%,0,0.0%,0,0,0,787,787,0,0,9,0,0,0,0\n2024-12-01,39,0,0.0%,0.0%,0.0%,0.0%,0,86,0,0,11,956,0,0,0,0,0,0,100.0%,0.0%,0,0.0%,6,0.0%,0,0,54,\"16,800\",\"16,900\",0,0,649,0,0,0,0\n"}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/abandoned/":{"get":{"tags":["Carts"],"summary":"Abandoned carts report","description":"Retrieves a report of any abandoned carts that match the specified filters.","operationId":"getAbandonedCarts","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}},{"name":"id__sort","in":"query","description":"How to sort the messages using thweir id:\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1],"default":-1}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_3"},"examples":{"success":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc12345/abandoned/?date_start=01-01-2024&id__sort=1&limit=2&page=2"},"count":64,"total":64,"page":1,"results":[{"id":"670ce036a309f1fb27245295","pid":"670cdf7259bc4e231ed4c9a6","dt":"2024-10-14T09:05:32Z","cart":{"dt":"2024-10-14T09:05:32Z","cv":18,"cp_delta":18,"u":"https://experiencedemo.myshopify.com/41163128999/checkouts/ac/e4b65598e55ab35e22103c7a766bc6f2/recover?key=68a7c14bbc8bda72d0354928016bb479&locale=en-GB","qty":1,"sbr":"experiencedemo","curr":"GBP","lang":"en-GB","p":[{"qty":1,"sbr":"experiencedemo","lang":"en-GB","prid":"5354106781863","vid":"34795696980135","opt":{"shopify":{}},"_id":"Rn3R6eEi4mEKMtsWoTWJtg==","curr":"GBP","uv":18,"up":"£18.00"}]},"v":18,"q":{},"type":"b"},{"id":"670ce036a309f1fb27245298","pid":"670cdf72c8e1eaf5ccadd422","dt":"2024-10-14T09:05:31Z","cart":{"dt":"2024-10-14T09:05:31Z","cv":18,"cp_delta":18,"u":"https://experiencedemo.myshopify.com/41163128999/checkouts/e4b65598e55ab35e22103c7a766bc6f2/recover?key=68a7c14bbc8bda72d0354928016bb479","qty":1,"sbr":"experiencedemo","curr":"GBP","lang":"en","p":[{"qty":1,"sbr":"experiencedemo","lang":"en","prid":"5354106781863","vid":"34795696980135","_id":"qAHnT8jSPOJMISSd3hnAhg==","curr":"GBP","uv":18,"up":"£18.00"}]},"v":18,"q":{},"type":"b"}],"headers":{"dt":"Date","v":"Value","cart.cp":"Local Value","cart.curr":"Currency Code","email":"Email","mobile":"Mobile","q.campaign_id":"Campaign","q.link_id":"Link","q.source":"Source","cart.p.0.n":"Product 1","cart.p.0.up":"Product 1 Price","cart.p.0.qty":"Product 1 Qty","cart.p.0.prid":"Product 1 ID","cart.p.1.n":"Product 2","cart.p.1.up":"Product 2 Price","cart.p.1.qty":"Product 2 Qty","cart.p.1.prid":"Product 2 ID","cart.p.2.n":"Product 3","cart.p.2.up":"Product 3 Price","cart.p.2.qty":"Product 3 Qty","cart.p.2.prid":"Product 3 ID","cart.sbr":"Site Brand","cart.u":"Cart URL"}}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/recovered/":{"get":{"tags":["Carts"],"summary":"Recovered carts report","description":"Retrieves a report of any recovered carts that match the specified filters.","operationId":"getRecoveredCarts","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}},{"name":"id__sort","in":"query","description":"How to sort the messages using thweir id:\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1],"default":-1}},{"name":"sbr","in":"query","description":"Filter to recoveries by this site brand only.","required":false,"schema":{"type":"string"}},{"name":"action_index","in":"query","description":"Filter to recoveries with this action index only.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_4"},"examples":{"success":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc12345/recovered/?id__sort=1&limit=2&page=2"},"count":4,"total":4,"page":1,"results":[{"id":"60cb74ef1aea8f0a49d2d1e4","pid":"5f030182e7c43735ad0fa393","dt":"2021-06-17T16:12:23Z","cart":{"sbr":"experiencedemo","curr":"GBP","qty":1,"p":[{"sbr":"experiencedemo","opt":{"shopify":{}},"curr":"GBP","vid":"34795693506727","prid":"5354106060967","qty":1,"ex":{},"cat":["vendor:neff","beanies","collection:gloves-and-hats"],"ruv":30,"rup":"£30.00","uv":30,"up":"£30.00","n":"Florz","_id":"R3LkYMUYH_nx1vpzOAV_pA==","stock":6}],"dt":"2021-06-17T16:12:23Z","cv":30},"v":30,"email":"lucy.russell@freshrelevance.com","b_signal":{"dt":"2021-06-17T15:50:28Z","type":"b","evdt":"2021-06-17T15:45:21Z","cart":{"sbr":"experiencedemo","curr":"GBP","qty":1,"p":[{"sbr":"experiencedemo","opt":{"shopify":{}},"curr":"GBP","vid":"34795693506727","uv":30,"up":"£30.00","qty":1,"cat":[],"ex":{},"_id":"R3LkYMUYH_nx1vpzOAV_pA=="}],"u":"https://experiencedemo.myshopify.com/41163128999/checkouts/0f1081f1e2961d43c46b76dd1cb3bb6d/recover?key=c4a93e58b066e3825b16aa522d286fdd","cp_delta":0,"dt":"2021-06-17T15:45:21Z","cv":30}},"q":{"tmti":1,"tmty":"ba","tmtk":"gzijfe8","tmrl":"7suoryi"},"o_num":"#1024","key":"gzijfe8","program_type":"ba","action_index":1,"stage":"Message 1","triggerName":"5 min Browse Abandon - Send 1 Email using a Transactional ESP","programTypeName":"Browse Abandon"},{"id":"61a60d3e301af2569f85603a","pid":"61a604bd4c73733c619e88c4","dt":"2021-11-30T11:36:07Z","cart":{"sbr":"experiencedemo","curr":"GBP","qty":1,"p":[{"sbr":"experiencedemo","opt":{"shopify":{}},"curr":"GBP","vid":"34795696980135","prid":"5354106781863","qty":1,"ex":{"Color":"Purple","n":"Purple"},"rup":"£18.00","cat":["collection:gloves-and-hats","collection:smart-collection","beanies","color:purple","collection:8","collection:9","vendor:neff","collection:7","collection:4","collection:5","collection:6","collection:3","collection:0","collection:1"],"ruv":18,"uv":18,"up":"£18.00","n":"Daily Heather","_id":"CBo5-hfEej25o30OYxWp2A==","stock":1}],"dt":"2021-11-30T11:36:07Z","cv":18},"v":18,"email":"blackhole@freshrelevance.com","b_signal":{"dt":"2021-11-30T11:07:54Z","type":"b","evdt":"2021-11-30T11:02:28Z","cart":{"sbr":"experiencedemo","curr":"GBP","qty":1,"p":[{"sbr":"experiencedemo","curr":"GBP","vid":"34795696980135","uv":18,"up":"£18.00","qty":1,"cat":["vendor:neff","beanies","collection:smart-collection","collection:gloves-and-hats","color:purple","collection:8","collection:9","collection:6","collection:7","collection:4","collection:5","collection:3","collection:0","collection:1"],"ex":{"Color":"Purple","n":"Purple"},"rup":"£18.00","_id":"CBo5-hfEej25o30OYxWp2A==","ruv":18,"stock":2}],"u":"https://experiencedemo.myshopify.com/41163128999/checkouts/5d2c38b3b4a6da0e9ed5a8c9dd47468b/recover?key=fef4c2645ffb49c6a873cb7973e08074","cp_delta":0,"dt":"2021-11-30T11:02:28Z","cv":18}},"q":{"tmti":1,"tmty":"b","tmtk":"sc0tkf4","tmrl":"70kf3rk"},"o_num":"#1036","key":"sc0tkf4","program_type":"b","action_index":1,"stage":"Message 1","triggerName":"Abandon Cart - Send 1 Email using a Transactional ESP Hest","programTypeName":"Cart Abandon"}],"headers":{"dt":"Date","v":"Value","cart.cp":"Local Value","email":"Email","mobile":"Mobile","b_signal.dt":"Abandon Date","b_signal.cart.cp":"Abandon Value","q.campaign_id":"Campaign","q.link_id":"Link","q.source":"Source","triggerName":"Trigger","programTypeName":"Program Type","stage":"Stage","o_num":"Order Number","cart.p.0.n":"Product 1","cart.p.0.up":"Product 1 Price","cart.p.0.qty":"Product 1 Qty","cart.p.0.prid":"Product 1 ID","cart.p.1.n":"Product 2","cart.p.1.up":"Product 2 Price","cart.p.1.qty":"Product 2 Qty","cart.p.1.prid":"Product 2 ID","cart.p.2.n":"Product 3","cart.p.2.up":"Product 3 Price","cart.p.2.qty":"Product 3 Qty","cart.p.2.prid":"Product 3 ID","cart.sbr":"Site Brand","cart.u":"Cart URL"}}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/purchased/":{"get":{"tags":["Carts"],"summary":"Purchased carts report","description":"Retrieves a report of any purchased carts that match the specified filters.","operationId":"getPurchasedCarts","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}},{"name":"id__sort","in":"query","description":"How to sort the messages using thweir id:\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1],"default":-1}},{"name":"sbr","in":"query","description":"Filter to this site brand only.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_5"},"examples":{"success":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc12345/purchased/?id__sort=1&limit=2&page=2"},"count":2262,"total":2262,"page":1,"results":[{"id":"5efe01deb6c99171cf5a2d48","pid":"5efc6b9f69dee731d4201aa9","dt":"2020-07-02T15:45:19Z","cart":{"curr":"GBP","pdt":"2020-07-02T15:45:19Z","qty":1,"p":[{"curr":"GBP","vid":"34795687313575","ai":{"updated":"2020-07-02T14:55:27.742000Z","meta":{"uv_z":-0.8264340245050971,"uv_scaled":0.024986103390772653,"uv":44.95},"uv_ex_outliers":0,"uv_thirds_sorted_price":0,"uv_thirds":0},"dtadded":"2020-07-02T11:03:53.214000Z","prid":"5354105471143","qty":1,"ex":{"Color":"Black/Stout White","n":"Black/Stout White"},"rup":"£44.95","dt":"2020-07-02T11:03:53.216000Z","n":"Irie","ruv":44.95,"variants":{"34795687313575":{"curr":"GBP","img":"https://cdn.shopify.com/s/files/1/0411/6312/8999/products/15338100115_1_720x598_72_RGB.jpg?v=1592558304","vid":"34795687313575","desc":"<p><em>This is a demonstration store. You can purchase products like this from <a href=\"//skiandscuba.com\" target=\"_blank\">The Ski Chalet &amp; Treasure Cove Scuba</a>.</em></p><ul>\n<li><span style=\"line-height: 1.4;\">100% Acrylic</span></li>\n<li>One Size Fits All</li>\n</ul>","uv":44.95,"up":"£44.95","n":"Irie","u":"https://experiencedemo.myshopify.com/products/burton-l-a-m-b-irie-beanie-2016","dt":"2020-07-02T11:03:53.216000Z","ruv":44.95,"rup":"£44.95","stock":1}},"desc":"<p><em>This is a demonstration store. You can purchase products like this from <a href=\"//skiandscuba.com\" target=\"_blank\">The Ski Chalet &amp; Treasure Cove Scuba</a>.</em></p><ul>\n<li><span style=\"line-height: 1.4;\">100% Acrylic</span></li>\n<li>One Size Fits All</li>\n</ul>","variant_array":[{"uv":44.95}],"img":"https://cdn.shopify.com/s/files/1/0411/6312/8999/products/15338100115_1_720x598_72_RGB.jpg?v=1592558304","uv":44.95,"up":"£44.95","cat":[{"_id":"color:black-stout-white","g":"Color","catid":"color:black-stout-white","n":"Black/Stout White","gid":"color","v":true,"dt":"2020-07-02T15:48:46.488000Z","r":false},{"_id":"vendor:burton","g":"Vendor","catid":"vendor:burton","n":"Burton","gid":"vendor","dt":"2020-07-02T15:46:16.440000Z","r":false}],"u":"https://experiencedemo.myshopify.com/products/burton-l-a-m-b-irie-beanie-2016","_id":"3ArQShq2OGLptMTcr08W5A==","stock":1}],"dt":"2020-07-02T15:45:19Z","cart_id":"74f85df03aff3c88684e57a340cd38c7"},"v":44.95,"email":"test@test.com","q":{},"o_num":"#1016","stage":"","attributions":[{"attv":44.95,"attw":1}],"assists":[{"assw":1,"assv":44.95}]},{"id":"5fad57fa3c50022c3cd357dc","pid":"5eff4c342420bc434e03a02e","dt":"2020-11-12T15:39:20Z","cart":{},"v":0,"q":{},"stage":"","attributions":[{"attv":0,"attw":1}],"assists":[{"assw":1,"assv":0}]}],"headers":{"dt":"Date","v":"Value","cart.cp":"Local Value","email":"Email","mobile":"Mobile","o_num":"Order Number","q.campaign_id":"Campaign","q.link_id":"Link","q.source":"Source","q.tmcs":"Layout Clicked","q.tmtk":"Trigger Clicked","stage":"Stage","cart.p.0.n":"Product 1","cart.p.0.up":"Product 1 Price","cart.p.0.qty":"Product 1 Qty","cart.p.0.prid":"Product 1 ID","cart.p.1.n":"Product 2","cart.p.1.up":"Product 2 Price","cart.p.1.qty":"Product 2 Qty","cart.p.1.prid":"Product 2 ID","cart.p.2.n":"Product 3","cart.p.2.up":"Product 3 Price","cart.p.2.qty":"Product 3 Qty","cart.p.2.prid":"Product 3 ID","cart.sbr":"Site Brand","cart.u":"Cart URL"}}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/carted/":{"get":{"tags":["Carts"],"summary":"Carted report","description":"Retrieves a report of any carted products that match the specified filters.","operationId":"getCarted","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}},{"name":"id__sort","in":"query","description":"How to sort the messages using thweir id:\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1],"default":-1}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_6"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/messages_sent/":{"get":{"tags":["Messages"],"summary":"Messages sent report","description":"Retrieves a report of any messages sent that match the specified filters.","operationId":"getMessagesSent","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}},{"name":"id__sort","in":"query","description":"How to sort the messages using thweir id:\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1],"default":-1}},{"name":"email","in":"query","description":"Filter to messages to this email address.","required":false,"schema":{"type":"string"}},{"name":"tk","in":"query","description":"Filter to messages sent by this program trigger key.","required":false,"schema":{"type":"string"}},{"name":"type","in":"query","description":"Filter to messages sent of this type.","required":false,"schema":{"type":"string","enum":["b","ba","t","cu","pcv","pcs"]}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_7"},"examples":{"success":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc12345/messages_sent/?limit=3&page=2"},"count":649,"total":649,"page":1,"results":[{"id":"677e8247289d1b03a23b9783","pid":"64f7201acdcc769e9dd09a2f","dt":"2025-01-08T13:48:55.996000Z","email":"joe.bloggs@emailsim.io","tk":"6l70pa1","type":"ba","action_index":1,"stage":"Message 1","typeString":"Browse Abandon","triggerName":"10 min Browse Abandon - Send 1 Email using a Transactional ESP","catchall":"laura.nixon@dotdigital.com","medium_name":"email"},{"id":"6749fc6d8d7da9d33bb12302","pid":"662a267a9828b2ff713fb9fd","dt":"2024-11-29T17:39:57.929000Z","email":"example@example.com","tk":"kltmks6","type":"t","action_index":1,"stage":"Message 1","typeString":"Purchase Complete","triggerName":"Purchase Complete - Send 1 message using a transactional email provider","catchall":"","medium_name":"email"},{"id":"6733653af9a96c2a398b9240","pid":"662a267a9828b2ff713fb9fd","dt":"2024-11-12T14:24:58.651000Z","email":"example@example.com","tk":"6l70pa1","type":"ba","action_index":1,"stage":"Message 1","typeString":"Browse Abandon","triggerName":"10 min Browse Abandon - Send 1 Email using a Transactional ESP","catchall":"","medium_name":"email"}],"headers":{"email":"Email","mobile":"Mobile","medium_name":"Medium","dt":"Date","triggerName":"Trigger","stage":"Stage","typeString":"Type","catchall":"Catchall"}}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/unsub/":{"get":{"tags":["Messages"],"summary":"Unsubscribes report","description":"Retrieves a report of any unsubscribes from marketing that match the specified filters.","operationId":"getUnsubscribes","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"id__gt","in":"query","description":"The record id to get records from.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_8"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports_summary/":{"get":{"tags":["Summary"],"summary":"Summary report","description":"Retrieves a report of key performance metrics that match the specified filters. Defaults to last day if no `date_start` is passed.","operationId":"getSummary","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_9"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports_outline/":{"get":{"tags":["Summary"],"summary":"Summary outline","description":"Retrieves a more detailed outline summary report of key performance metrics that match the specified filters. Defaults to last day if no `date_start` is passed.","operationId":"getOutline","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_10"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/usage/":{"get":{"tags":["Summary"],"summary":"Usage summary","description":"Retrieves a usage report for the specified date range and the current and previous billing month. Defaults to a date range of the last day if no `date_start` is passed.","operationId":"getUsage","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"date_start","in":"query","description":"Start date for reporting data in ISO-8601 format, defaults to previous day.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for reporting data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Successful call.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_11"}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports/item/overview/{type}/":{"get":{"tags":["Overviews"],"summary":"Get overview report","description":"Retrieves an overview of the usage and analytics for a entity type for the specified filter criteria.","operationId":"getOverviewReport","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"type","in":"path","description":"The type of entity you want an overview report for.","required":true,"schema":{"type":"string","enum":["smartblock","slot","trigger","campaign","experience"]}},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for the data in ISO-8601 format, defaults to the last 30 days.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for the data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"extragroup","in":"query","description":"The field to sort result by.","required":false,"schema":{"type":"string","enum":["tmsb","tmsl","tmti","tmtk","campaign","medium","source","tmrl","imp","at_p_p","at_p_q","at_p_e","at_q_e","as_p_p","as_p_q","as_p_e","as_q_e","ct","wmu","wmu_e","emu","emu_e","avt_p_p","ast_p_p","at_p_rpm","as_p_rpm","ms_q","apv","at_p_rpmi","at_p_rpm_apv","at_p_rpme"]}},{"name":"sort","in":"query","description":"The sort directon.\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1]}}],"responses":{"200":{"description":"The page of overview data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_12"},"examples":{"smartblocks":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/smartblock/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":961,"total":961,"page":1,"results":[{"imp":2,"imp_cg":0,"tmsb":"11oetow","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":2,"imp_cg":0,"tmsb":"122jf55","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":2,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":1,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"slots":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/slot/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":626,"total":626,"page":1,"results":[{"imp":0,"imp_cg":0,"tmsl":"10-off-footwear-promo---banner-s40nr3e","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":1,"imp_cg":0,"tmsl":"2-countdown-email-p2-bump","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":1,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"triggers":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/trigger/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":31,"total":31,"page":1,"results":[{"imp":0,"imp_cg":0,"tmtk":"1ks01cw","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"ms_q":11,"ms_q_cg":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":0,"imp_cg":0,"tmtk":"1qlhikz","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"ms_q":7,"ms_q_cg":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"campaigns":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/campaign/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":44,"total":44,"page":1,"results":[{"imp":0,"imp_cg":0,"campaign_id":123,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":1,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":0,"imp_cg":0,"campaign_id":"Hester_camp1","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":5,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"experiences":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/experience/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":49,"total":49,"page":1,"results":[{"imp":0,"imp_cg":0,"exp_slugs":"1jk2zp3","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":8,"imp_cg":0,"exp_slugs":"1kc5v44","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":8,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports/item/overview/{type}/{slugs}/":{"get":{"tags":["Overviews"],"summary":"Get overview report","description":"Retrieves an overview of the usage and analytics for a entity type and specific item(s) for the specified filter criteria.","operationId":"getOverviewReportForItem","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"type","in":"path","description":"The type of entity you want an overview report for.","required":true,"schema":{"type":"string","enum":["smartblock","slot","trigger","campaign","experience"]}},{"name":"slugs","in":"path","description":"Comma delimited list of ids you want to filter the report to.","required":true,"schema":{"type":"array","items":{"type":"string","description":"Entity identifier"}}},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for the data in ISO-8601 format, defaults to the last 30 days.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for the data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"extragroup","in":"query","description":"The field to sort result by.","required":false,"schema":{"type":"string","enum":["tmsb","tmsl","tmti","tmtk","campaign","medium","source","tmrl","imp","at_p_p","at_p_q","at_p_e","at_q_e","as_p_p","as_p_q","as_p_e","as_q_e","ct","wmu","wmu_e","emu","emu_e","avt_p_p","ast_p_p","at_p_rpm","as_p_rpm","ms_q","apv","at_p_rpmi","at_p_rpm_apv","at_p_rpme"]}},{"name":"sort","in":"query","description":"The sort directon.\n* 1 - Ascending\n* -1 - Descending\n","required":false,"schema":{"type":"integer","enum":[1,-1]}}],"responses":{"200":{"description":"The page of overview data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_12"},"examples":{"smartblocks":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/smartblock/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":961,"total":961,"page":1,"results":[{"imp":2,"imp_cg":0,"tmsb":"11oetow","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":2,"imp_cg":0,"tmsb":"122jf55","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":2,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":1,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"slots":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/slot/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":626,"total":626,"page":1,"results":[{"imp":0,"imp_cg":0,"tmsl":"10-off-footwear-promo---banner-s40nr3e","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":1,"imp_cg":0,"tmsl":"2-countdown-email-p2-bump","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":1,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"triggers":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/trigger/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":31,"total":31,"page":1,"results":[{"imp":0,"imp_cg":0,"tmtk":"1ks01cw","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"ms_q":11,"ms_q_cg":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":0,"imp_cg":0,"tmtk":"1qlhikz","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"ms_q":7,"ms_q_cg":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"campaigns":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/campaign/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":44,"total":44,"page":1,"results":[{"imp":0,"imp_cg":0,"campaign_id":123,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":1,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":0,"imp_cg":0,"campaign_id":"Hester_camp1","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":5,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}},"experiences":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/overview/experience/?date_start=22-12-2019&limit=2&page=2&sort=-1"},"count":49,"total":49,"page":1,"results":[{"imp":0,"imp_cg":0,"exp_slugs":"1jk2zp3","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":0,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0},{"imp":8,"imp_cg":0,"exp_slugs":"1kc5v44","at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ct":0,"wmu":8,"emu":0,"apv":0,"t_c_norm":0,"nt_c_norm":0,"t_v_norm":0,"t_c_cg":0,"nt_c_cg":0,"t_v_cg":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"at_p_rpm":0,"at_p_rpme":0,"at_p_rpmi":0,"at_p_rpm_apv":0,"as_p_rpm":0,"as_p_rpme":0,"ast_p_p":0,"avt_p_p":0}]}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports/item/{type}/":{"get":{"tags":["Analytics"],"summary":"Get analytics report","description":"Retrieves an analytics report for a entity type for the specified filter criteria.","operationId":"getAnalyticsReport","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"type","in":"path","description":"The type of entity you want an analytics report for.\n* campaign - Campaign daily report\n* campaigns_details - Campaign details\n* slot - Slot daily report\n* smartblock - Smartblock daily report\n* trigger - Trigger daily report\n","required":true,"schema":{"type":"string","enum":["campaign","experience","slot","smartblock","trigger"]}},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for the data in ISO-8601 format, defaults to the last 30 days.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for the data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"extragroup","in":"query","description":"The field to sort result by.","required":false,"schema":{"type":"string","enum":["tmsb","tmsl","tmti","tmtk","campaign","medium","source","tmrl","imp","at_p_p","at_p_q","at_p_e","at_q_e","as_p_p","as_p_q","as_p_e","as_q_e","ct","wmu","wmu_e","emu","emu_e","avt_p_p","ast_p_p","at_p_rpm","as_p_rpm","ms_q","apv","at_p_rpmi","at_p_rpm_apv","at_p_rpme"]}}],"responses":{"200":{"description":"The page of analytics data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_13"},"examples":{"smartblocks":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/smartblock/?limit=2&page=2"},"count":22,"total":22,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":9,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":9,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsb":"tv6m2ur"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":29,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":29,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsb":"zi3vmhh"}}]}]}},"slots":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/slot/?limit=2&page=2"},"count":22,"total":22,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":9,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":9,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsl":"width-3-test"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":29,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":29,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsl":"width-3-test"}}]}]}},"triggers":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/trigger/?limit=2&page=2"},"count":14,"total":14,"page":1,"results":[{"_id":{"year":2024,"month":12,"day":31},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmtk":"sc0tkf4"}}]},{"_id":{"year":2025,"month":1,"day":7},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmtk":"k74ug8uk"}}]}]}},"campaigns":{"value":{"links":{},"count":1,"total":1,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":23},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"campaign_id":"[Google]"}}]}]}},"experiences":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/experience/?limit=2&page=2"},"count":14,"total":14,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"exp_slugs":"joj3uai"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"exp_slugs":"joj3uai"}}]}]}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/reports/item/{type}/{slugs}/":{"get":{"tags":["Analytics"],"summary":"Get analytics report for item(s)","description":"Retrieves an analytics report for a entity type and specific item(s) for the specified filter criteria.","operationId":"getAnalyticsReportForItem","parameters":[{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"},{"name":"type","in":"path","description":"The type of entity you want an analytics report for.\n* campaign - Campaign daily report\n* campaigns_details - Campaign details\n* slot - Slot daily report\n* smartblock - Smartblock daily report\n* trigger - Trigger daily report\n","required":true,"schema":{"type":"string","enum":["campaign","experience","slot","smartblock","trigger"]}},{"name":"slugs","in":"path","description":"Comma delimited list of ids you want to filter the report to.","required":true,"schema":{"type":"array","items":{"type":"string","description":"Entity identifier"}}},{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},{"name":"date_start","in":"query","description":"Start date for the data in ISO-8601 format, defaults to the last 30 days.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"date_end","in":"query","description":"End date for the data in ISO-8601 format, defaults to today.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"extragroup","in":"query","description":"The field to sort result by.","required":false,"schema":{"type":"string","enum":["tmsb","tmsl","tmti","tmtk","campaign","medium","source","tmrl","imp","at_p_p","at_p_q","at_p_e","at_q_e","as_p_p","as_p_q","as_p_e","as_q_e","ct","wmu","wmu_e","emu","emu_e","avt_p_p","ast_p_p","at_p_rpm","as_p_rpm","ms_q","apv","at_p_rpmi","at_p_rpm_apv","at_p_rpme"]}}],"responses":{"200":{"description":"The page of analytics data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/inline_response_200_13"},"examples":{"smartblocks":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/smartblock/?limit=2&page=2"},"count":22,"total":22,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":9,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":9,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsb":"tv6m2ur"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":29,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":29,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsb":"zi3vmhh"}}]}]}},"slots":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/slot/?limit=2&page=2"},"count":22,"total":22,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":9,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":9,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsl":"width-3-test"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":29,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":29,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmsl":"width-3-test"}}]}]}},"triggers":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/trigger/?limit=2&page=2"},"count":14,"total":14,"page":1,"results":[{"_id":{"year":2024,"month":12,"day":31},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmtk":"sc0tkf4"}}]},{"_id":{"year":2025,"month":1,"day":7},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"tmtk":"k74ug8uk"}}]}]}},"campaigns":{"value":{"links":{},"count":1,"total":1,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":23},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"campaign_id":"[Google]"}}]}]}},"experiences":{"value":{"links":{"next":"https://api.freshrelevance.com/api/abc1234/reports/item/experience/?limit=2&page=2"},"count":14,"total":14,"page":1,"results":[{"_id":{"year":2025,"month":1,"day":2},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"exp_slugs":"joj3uai"}}]},{"_id":{"year":2025,"month":1,"day":3},"items":[{"imp":0,"imp_cg":0,"at_p_p":0,"at_p_q":0,"as_p_p":0,"as_p_q":0,"ms_q":0,"ms_q_cg":0,"emu":0,"wmu":0,"ct":0,"popover_shown":0,"popover_dismiss":0,"popover_submit":0,"type_id":{"exp_slugs":"joj3uai"}}]}]}}}}}},"400":{"$ref":"#/components/responses/ErrorResponse"},"401":{"description":"Unauthorized"},"403":{"$ref":"#/components/responses/403Response"}}}}},"components":{"schemas":{"attributionDetails":{"required":["attv","attw","keys"],"type":"object","properties":{"keys":{"type":"object","description":"Any associated tracking keys.","example":{"campaign_id":"[Google]","st":"cm"}},"attv":{"type":"number","description":"Attributed value.","example":199.99},"attw":{"type":"number","description":"Attributed weight.","example":1}},"description":"Attribution details."},"assistDetails":{"required":["assv","assw","keys"],"type":"object","properties":{"keys":{"type":"object","description":"Any associated tracking keys.","example":{"campaign_id":"[Google]","st":"cm"}},"assv":{"type":"number","description":"Asssistance value.","example":199.99},"assw":{"type":"number","description":"Assistance weight.","example":1}},"description":"Assist details."},"Product":{"required":["_id"],"type":"object","properties":{"_id":{"type":"string","description":"The Dotdigital Personalization unique identifier for a product.","example":"hK8cs10zbudEoqpkl2IvFQ=="},"related":{"type":"array","description":"The product ids related to this product.","example":["32323211","21324343"],"items":{"type":"string"}},"cat":{"type":"array","description":"The categories the product belongs to.","example":["Skis"],"items":{"type":"string"}},"curr":{"type":"string","description":"Price currency - ISO 4217 currency code.","example":"USD"},"n":{"type":"string","description":"Name of the product.","example":"Ti Xelium Skis DH6"},"u":{"type":"string","description":"Product URL.","format":"url","example":"https://example.com/prd/5354127294631"},"prid":{"type":"string","description":"Your unique product id.","example":"5354127294631"},"sku":{"type":"string","description":"The SKU for the product.","example":"SKI-TI-XELIUM-DH6"},"rid":{"type":"string","description":"Product review ID.","example":"df234a"},"sbr":{"type":"string","description":"Site brand.","example":"AbsoluteSki"},"desc":{"type":"string","description":"Product description.","example":"Power turn skis"},"img":{"type":"string","description":"Product image URL.","format":"url"},"img_tn":{"type":"string","description":"Product thumbnail URL.","format":"url"},"uv":{"type":"number","description":"Unit value, price in numeric format.","example":180},"up":{"type":"string","description":"Unit price, price with currency symbol.","example":"$180.00"},"ruv":{"type":"number","description":"Regular unit value (e.g. price before any sale or offer) numeric value.","example":220},"rup":{"type":"string","description":"Regular unit price (e.g. price before any sale or offer) value with currency symbol.","example":"$220.00"},"qty":{"type":"integer","description":"Quantity sold in e.g. multi packs.","example":1},"stock":{"type":"integer","description":"Quantity in stock.","example":12},"ex":{"type":"object","description":"Extension properties.","example":{"color":"red","width":330,"height":1500,"depth":260}},"opt":{"$ref":"#/components/schemas/Product_opt"},"lang":{"type":"string","description":"Language of the product description using ISO 639 language codes.","example":"en"},"promo":{"type":"array","description":"Promotional flags.","items":{"type":"string"}},"reviews":{"$ref":"#/components/schemas/Product_reviews"},"review_locale":{"type":"string","description":"Language Location using a combination of ISO 639 language codes and ISO 3166-1 alpha-2 format country code.","example":"en-GB"},"vid":{"type":"string","description":"Variant identifier.","example":"5354127294631-1"},"pth":{"type":"string","description":"Path of the product e.g. clothes/jumpers. Should only be used of the path is fixed for one product. Product ID / SKU preferred.","example":"snow/skis/5354127294631"},"variants":{"type":"array","description":"Variants","items":{"type":"object"}},"location_ids":{"type":"array","description":"Location ids for this product.","items":{"type":"string"}},"variant_count":{"type":"integer","description":"How many variants exist.","example":3},"variant_keys":{"type":"array","description":"List of variant ids","items":{"type":"string"}},"dt":{"type":"string","description":"Date last modified in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"edt":{"type":"string","description":"Date last used in an email in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"dtadded":{"type":"string","description":"Date first added in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"},"ai":{"type":"object","description":"AI details."},"meta":{"type":"object","description":"Meta data."}},"description":"Product details"},"CartContents":{"type":"object","properties":{"dt":{"type":"string","description":"The date time the cart was created in UTC ISO-8601 format.","format":"date-time","example":"2024-10-14T09:05:32Z"},"cv":{"type":"number","description":"Cart Value, as a number","example":134},"cp_delta":{"type":"number","description":"Cart price delta","example":164},"u":{"type":"string","description":"URL to get back to the cart (e.g. from an email), if known","format":"url"},"qty":{"type":"integer","description":"Number of items in the cart","example":1},"sbr":{"type":"string","description":"Site Brand/Territory for the product (e.g. the product was shown in USD on the US version of the store)","example":"DEMO"},"curr":{"type":"string","description":"Currency - ISO 4217 currency code","example":"USD"},"lang":{"type":"string","description":"Language for the cart / session. The prefix, 'en', is a language code following the ISO 639-1 standard. The suffix, 'US', is a country code following the ISO 3166-1 Alpha-2 standard.","example":"en_us"},"p":{"type":"array","description":"Cart items","items":{"$ref":"#/components/schemas/CartContents_p"}}}},"PaginatedData":{"required":["count","links","page","total"],"type":"object","properties":{"page":{"minimum":1,"type":"integer","description":"The index for the page of data returned.","example":1},"count":{"minimum":0,"type":"integer","description":"Number of records in the page.","example":12},"total":{"minimum":0,"type":"integer","description":"Total number of records in the set.","example":12},"links":{"$ref":"#/components/schemas/PaginatedData_links"}},"description":"Data page and pagination links"},"inline_response_200":{"required":["results","total"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_results"}},"total":{"type":"integer","description":"The total number of records retrieved."}},"description":"The campaigns conversions summary data for the time period."},"inline_response_200_1":{"required":["count","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_1_results"}},"count":{"type":"integer","description":"The count of records retrieved."}},"description":"The campaigns conversions detailed data for the time period."},"inline_response_200_2":{"required":["oColumnTotals","results","total"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_2_results"}},"total":{"type":"integer","description":"The total number of records retrieved."},"oColumnTotals":{"$ref":"#/components/schemas/inline_response_200_2_oColumnTotals"}},"description":"The daily conversion summary data for the time period."},"inline_response_200_3":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_3_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_3_headers"}},"description":"The abandoned carts."},"inline_response_200_4":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_4_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_4_headers"}},"description":"The recovered carts."},"inline_response_200_5":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_5_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_5_headers"}},"description":"The purchased carts."},"inline_response_200_6":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_6_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_6_headers"}},"description":"The purchased carts."},"inline_response_200_7":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_7_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_7_headers"}},"description":"The messages."},"inline_response_200_8":{"required":["headers","results"],"type":"object","properties":{"results":{"type":"array","items":{"$ref":"#/components/schemas/inline_response_200_8_results"}},"headers":{"$ref":"#/components/schemas/inline_response_200_8_headers"}},"description":"The purchased carts."},"inline_response_200_9":{"required":["abandoned_value","purchased_value","recovered_value","recovered_value_b","recovered_value_ba","results","timespan"],"type":"object","properties":{"results":{"type":"array","example":[],"items":{"type":"object"}},"timespan":{"type":"integer","description":"The number of days the data includes from the start date if a limit has been applied, else `null` if the results cover the full time range.","nullable":true},"abandoned_value":{"type":"number","description":"The value of the abondoned baskets in the period.","example":20999.99},"purchased_value":{"type":"number","description":"The value of the purchased baskets in the period.","example":350999},"recovered_value":{"type":"number","description":"The value of the recovered sales in the period.","example":10000},"recovered_value_b":{"type":"number","description":"The value of the recovered sales from abondoned browse interventions in the period.","example":10999.99},"recovered_value_ba":{"type":"number","description":"The value of the recovered sales from abonadoned basket interventions in the period.","example":20999.99}},"description":"The summary statistics."},"inline_response_200_10":{"required":["abandoned_value","cart_abandon_qty","cart_abandon_qty_identified","cart_abandon_qty_not_identified","customer_count","email_count","messages_sent","messages_sent_b","messages_sent_ba","product_count","purchased_value","recovered_value","recovered_value_b","recovered_value_ba","results","timespan"],"type":"object","properties":{"results":{"type":"array","example":[],"items":{"type":"object"}},"timespan":{"type":"integer","description":"The number of days the data includes from the start date if a limit has been applied, else `null` if the results cover the full time range.","nullable":true},"customer_count":{"type":"integer","description":"The number of customer in the period.","example":22860},"email_count":{"type":"integer","description":"The number of customers with emails in the period.","example":22606},"product_count":{"type":"integer","description":"The number of products imported in the period.","example":19223},"abandoned_value":{"type":"number","description":"The value of the abondoned baskets in the period.","example":20999.99},"purchased_value":{"type":"number","description":"The value of the purchased baskets in the period.","example":350999},"recovered_value":{"type":"number","description":"The value of the recovered sales in the period.","example":10000},"recovered_value_b":{"type":"number","description":"The value of the recovered sales from abondoned cart interventions in the period.","example":10999.99},"recovered_value_ba":{"type":"number","description":"The value of the recovered sales from abonadoned browse interventions in the period.","example":20999.99},"messages_sent":{"type":"integer","description":"The number of messages sent in the period.","example":2140},"messages_sent_b":{"type":"integer","description":"The number of cart abandonment messages sent in the period.","example":1000},"messages_sent_ba":{"type":"integer","description":"The number of browse abandonment messages sent in the period.","example":1140},"cart_abandon_qty_identified":{"type":"integer","description":"The number of cart abandonments that we could identify a contact in the period.","example":1000},"cart_abandon_qty_not_identified":{"type":"integer","description":"The number of cart abandonments that we couldn't identify a contact for in the period.","example":3500},"cart_abandon_qty":{"type":"integer","description":"The total number of cart abandonments in the period.","example":4500}},"description":"The summary statistics."},"inline_response_200_11":{"required":["best_guess_emu_projected_monthly","best_guess_page_views_projected_monthly","best_guess_wmu_projected_monthly","billing_end_date","billing_month_eir","billing_month_emu","billing_month_page_views","billing_month_wmu","billing_start_date","current_month_eir_percent","date_end","date_range_content_emu","date_range_page_views","date_range_wmu","date_start","is_annual","previous_billing_month_emu","previous_billing_month_page_views","previous_billing_month_wmu","usage"],"type":"object","properties":{"is_annual":{"type":"boolean","description":"Whether billing is based on annual cadence or not.","example":false},"billing_month_page_views":{"type":"integer","description":"The number of page views in the current billable month.","example":22860},"previous_billing_month_page_views":{"type":"integer","description":"The number of page views in the previous billable month.","example":22606},"best_guess_page_views_projected_monthly":{"type":"integer","description":"The estimated number of page views on average in a billable month.","example":19223},"billing_start_date":{"type":"string","description":"The start date for the current billing period in UTC ISO-8601 format.","format":"date-time"},"billing_end_date":{"type":"string","description":"The end date for the current billing period in UTC ISO-8601 format.","format":"date-time"},"date_range_page_views":{"type":"integer","description":"The number of page views in the requested date range.","example":100000},"date_start":{"type":"string","description":"The start date for the requested date range in UTC ISO-8601 format.","format":"date-time","example":"2023-01-01T00:00:00Z"},"date_end":{"type":"string","description":"The end date for the requested date range in UTC ISO-8601 format.","format":"date-time","example":"2024-01-01T00:00:00Z"},"billing_month_emu":{"type":"integer","description":"The number of email impressions in the current billable month.","example":2140},"previous_billing_month_emu":{"type":"integer","description":"The number of email impressions in the previous billable month.","example":2140},"billing_month_eir":{"type":"integer","description":"The number of email images returned in the current billable month.","example":1140000},"current_month_eir_percent":{"type":"number","description":"The percentage of email images returned in the current billable month.","example":10.52},"date_range_content_emu":{"type":"integer","description":"The number of email impressions in the requested date range.","example":514005},"best_guess_emu_projected_monthly":{"type":"integer","description":"The estimated number of email impressions in a billable month.","example":2140},"billing_month_wmu":{"type":"integer","description":"The number of web impressions in the current billable month.","example":56140050},"previous_billing_month_wmu":{"type":"integer","description":"The number of web impressions in the previous billable month.","example":45740030},"date_range_wmu":{"type":"integer","description":"The number of web impressions in the requested date range.","example":458955755},"best_guess_wmu_projected_monthly":{"type":"integer","description":"The estimated number of web impressions in a billable month.","example":44746030},"usage":{"$ref":"#/components/schemas/inline_response_200_11_usage"}},"description":"The usage statistics."},"inline_response_200_12":{"allOf":[{"$ref":"#/components/schemas/PaginatedData"},{"required":["results"],"type":"object","properties":{"results":{"type":"array","description":"The analytics.","items":{"$ref":"#/components/schemas/inline_response_200_12_results"}}}}]},"inline_response_200_13":{"allOf":[{"$ref":"#/components/schemas/PaginatedData"},{"required":["results"],"type":"object","properties":{"results":{"type":"array","description":"The analytics.","items":{"$ref":"#/components/schemas/inline_response_200_13_results"}}}}]},"Product_opt":{"type":"object","properties":{"img":{"type":"string","description":"Product image URL.","format":"url"},"img_tn":{"type":"string","description":"Product thumbnail URL.","format":"url"},"n":{"type":"string","description":"Name of the product.","example":"Ti Xelium Skis DH6"},"u":{"type":"string","description":"Product URL.","format":"url","example":"https://example.com/prd/5354127294631"},"uv":{"type":"number","description":"Unit value, price in numeric format.","example":180},"up":{"type":"string","description":"Unit price, price with currency symbol.","example":"$180.00"},"ruv":{"type":"number","description":"Regular unit value (e.g. price before any sale or offer) numeric value.","example":220},"rup":{"type":"string","description":"Regular unit price (e.g. price before any sale or offer) value with currency symbol.","example":"$220.00"}},"description":"Options"},"Product_reviews":{"type":"object","properties":{"dt":{"type":"string","description":"Date of last review in ISO-8601 format.","example":"2024-10-31T05:38:33.878Z"}},"description":"Product review details."},"CartContents_cat":{"type":"object","properties":{"g":{"type":"string","description":"Category Group Name","example":"top-level"},"n":{"type":"string","description":"Category Name","example":"Snowboard"},"r":{"type":"boolean","description":"Replace the category on the product data with this","example":true,"default":false}}},"CartContents_variants":{"required":["vid"],"type":"object","properties":{"vid":{"type":"string","description":"Variant ID","example":"B_M"},"sku":{"type":"string","description":"Optional SKU of variant","example":"Bonfire:Blackline:Pant:Blue:Medium"},"stock":{"type":"integer","description":"Optional stock of variant","example":10},"n":{"type":"string","description":"Optional variant name override","example":"Bonfire Blackline Pant 2018 Blue (M)"},"img":{"type":"string","description":"Optional variant image override, URL to large product image","format":"uri","example":"https://democdn.freshrelevance.com/pub/media/catalog/product/b/o/bonfire-blackline-pant-2018.jpg"},"img_tn":{"type":"string","description":"Optional variant thumbnail override, URL to thumbnail product image","format":"uri","example":"https://democdn.freshrelevance.com/pub/media/catalog/product/b/o/bonfire-blackline-pant-2018.jpg"},"u":{"type":"string","description":"Optional variant URL override","format":"url","example":"https://demo.freshrelevance.com/bonfire-blackline-pant-2018.html?___store%5B_data%5D%5Bstore_id%5D=1&___store%5B_data%5D%5Bcode%5D=default&___store%5B_data%5D%5Bwebsite_id%5D=1&___store%5B_data%5D%5Bgroup_id%5D=1&___store%5B_data%5D%5Bname%5D=Default+Store+View&___store%5B_data%5D%5Bsort_order%5D=0&___store%5B_data%5D%5Bis_active%5D=1&___store%5B_data%5D%5Bavailable_currency_codes%5D%5B0%5D=USD&___store%5B_data%5D%5Bbase_currency%5D%5B_data%5D%5Bcurrency_code%5D=USD&___store%5B_data%5D%5Bcurrent_currency%5D%5B_data%5D%5Bcurrency_code%5D=USD"},"ex":{"type":"object","additionalProperties":true,"description":"Optional variant extra data override","example":{"productType":{"type":"string","example":"simple"}}},"up":{"type":"string","description":"Optional unit Price for the variant (as seen by the user - e.g. sale price, offer price)","example":"$139.00"},"uv":{"type":"number","description":"Optional unit Value for the variant with no currency symbol","example":194},"rup":{"type":"string","description":"Optional regular Unit Price for the variant (e.g. price before any sale or offer)","example":"$164.00"},"ruv":{"type":"number","description":"Optional regular Unit Price for the variant (e.g. price before any sale or offer) for the product with no currency symbol","example":164},"desc":{"type":"string","description":"Optional variant description override","example":"The Bonfire Blackline pants come from Bonfires Gold range which means high quality fabrics and tech with stylish performance driven designs at a great price point. With 28 years of doing this they know what they are doing and how to do it well! With 15,000mm waterproof rating and 10,000gm breathability you know you are going to stay warm and dry all day on the mountain. Bonfire back this with fully taped seams meaning every seam is waterproof tape backed so you won’t get water ingress either. For extra durability the Blackline pant uses triple stitched front and rear rise so front and back around the bum and groin area these are triple stitched. Meaning if you slide out on your bum a lot these will not wear through. The Blackline pant comes in Bonfires Ergo performance fit with a great shape to them, not too slim not too baggy and they look great! These are hard wearing pants with loads of tech plus Bonfire Pants carry a LIFETIME WARRANTY! This is against manufacturing defects not wear and tear but still huge piece of mind."},"cat":{"type":"array","description":"Optional variant category override. Will merge / replace matching categories","example":[{"g":"top-level","n":"Snowboard"},{"g":"gender","n":"Men's"},{"g":"subcat","n":"Bottoms","r":true}],"items":{"$ref":"#/components/schemas/CartContents_cat"}}},"description":"Variant"},"CartContents_reviews":{"type":"object","properties":{"rating":{"type":"number","description":"The aggregated rating of a particular product","example":4.9},"ratingCount":{"minimum":0,"type":"integer","description":"The number of ratings that have been given to a particular product","example":23}},"additionalProperties":false,"description":"Review information for the product"},"CartContents_p":{"required":["_id","n","prid","qty","up"],"type":"object","properties":{"_id":{"type":"string","description":"Unique id for record.","example":"n3tUS8590JxI7VIrB8rM9Q=="},"n":{"type":"string","description":"Product name","example":"Bonfire Blackline Pant 2018"},"qty":{"type":"number","description":"Quantity","example":1},"up":{"type":"string","description":"Unit Price for the product (as seen by the user - e.g. sale price, offer price)","example":"$134.00"},"uv":{"type":"number","description":"Unit Value for the product with no currency symbol","example":134},"rup":{"type":"string","description":"Regular Unit Price for the product (e.g. price before any sale or offer)","example":"$164.00"},"ruv":{"type":"number","description":"Regular Unit Price for the product (e.g. price before any sale or offer) for the product with no currency symbol","example":164},"img":{"type":"string","description":"URL to large product image","format":"uri","example":"https://democdn.freshrelevance.com/pub/media/catalog/product/b/o/bonfire-blackline-pant-2018.jpg"},"img_tn":{"type":"string","description":"URL to thumbnail product image","format":"uri","example":"https://democdn.freshrelevance.com/pub/media/catalog/product/b/o/bonfire-blackline-pant-2018.jpg"},"prid":{"type":"number","description":"Unique product identifier","example":97},"sku":{"type":"string","description":"Product SKU","example":"Bonfire:Blackline:Pant:2018"},"rid":{"type":"string","description":"ID used by review provider (if different from prid / sku)","example":"US_Bonfire:Blackline:Pant:2018"},"pth":{"type":"string","description":"Path of the product e.g. clothes/jumpers. Should only be provided if the path is fixed for one product","format":"url","example":"https://demo.freshrelevance.com/bonfire-blackline-pant-2018.html"},"desc":{"type":"string","description":"Product description","example":"The Bonfire Blackline pants come from Bonfires Gold range which means high quality fabrics and tech with stylish performance driven designs at a great price point. With 28 years of doing this they know what they are doing and how to do it well! With 15,000mm waterproof rating and 10,000gm breathability you know you are going to stay warm and dry all day on the mountain. Bonfire back this with fully taped seams meaning every seam is waterproof tape backed so you won’t get water ingress either. For extra durability the Blackline pant uses triple stitched front and rear rise so front and back around the bum and groin area these are triple stitched. Meaning if you slide out on your bum a lot these will not wear through. The Blackline pant comes in Bonfires Ergo performance fit with a great shape to them, not too slim not too baggy and they look great! These are hard wearing pants with loads of tech plus Bonfire Pants carry a LIFETIME WARRANTY! This is against manufacturing defects not wear and tear but still huge piece of mind."},"stock":{"type":"integer","description":"The product stock level","example":12},"curr":{"type":"string","description":"Currency - ISO 4217 currency code","example":"USD"},"cat":{"type":"array","description":"Items categories","example":[{"g":"top-level","n":"Snowboard"},{"g":"gender","n":"Men's"},{"g":"subcat","n":"Bottoms","r":true}],"items":{"$ref":"#/components/schemas/CartContents_cat"}},"ex":{"type":"object","additionalProperties":true,"description":"Extra properties for the product","example":{"productType":{"type":"string","example":"simple"}}},"opt":{"type":"object","properties":{},"additionalProperties":true,"description":"Personal options properties for the product (will not be merged into product database). e.g. size, colour, flight details","example":{"color":"blue","size":"m"}},"vid":{"type":"string","description":"Variant ID added to the cart","example":"B_M"},"variants":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CartContents_variants"},"description":"Any variants for the product"},"promo":{"minItems":1,"type":"array","description":"Selected promotion names","items":{"type":"string","description":"Promotion name"}},"sbr":{"type":"string","description":"Site Brand/Territory for the product (e.g. the product was shown in USD on the US version of the store)","example":"DEMO"},"lang":{"type":"string","description":"Language the product is displayed in. The prefix, 'en', is a language code following the ISO 639-1 standard. The suffix, 'US', is a country code following the ISO 3166-1 Alpha-2 standard.","example":"en_us"},"u":{"type":"string","description":"Product URL","format":"url","example":"https://demo.freshrelevance.com/bonfire-blackline-pant-2018.html?___store%5B_data%5D%5Bstore_id%5D=1&___store%5B_data%5D%5Bcode%5D=default&___store%5B_data%5D%5Bwebsite_id%5D=1&___store%5B_data%5D%5Bgroup_id%5D=1&___store%5B_data%5D%5Bname%5D=Default+Store+View&___store%5B_data%5D%5Bsort_order%5D=0&___store%5B_data%5D%5Bis_active%5D=1&___store%5B_data%5D%5Bavailable_currency_codes%5D%5B0%5D=USD&___store%5B_data%5D%5Bbase_currency%5D%5B_data%5D%5Bcurrency_code%5D=USD&___store%5B_data%5D%5Bcurrent_currency%5D%5B_data%5D%5Bcurrency_code%5D=USD"},"reviews":{"$ref":"#/components/schemas/CartContents_reviews"}},"description":"Individual cart item"},"PaginatedData_links":{"type":"object","properties":{"next":{"type":"string","description":"URL of the next page.","format":"url","nullable":true},"previous":{"type":"string","description":"URL of the previous page.","format":"url","nullable":true}},"description":"Page navigation links"},"inline_response_200_results":{"required":["_id","abandoned_p","abandoned_q","attributions","campaign_id","fmt_abandoned_p","fmt_abandoned_q","fmt_assisted_p","fmt_assisted_q","fmt_cp","fmt_purchased_p","fmt_purchased_q","fmt_v","last_click","link_id","lv","products","purchased_p","purchased_q","source","tmcs","tmsl","tmti_text","tmtk"],"type":"object","properties":{"_id":{"type":"string","description":"The unique id of the record.","nullable":true},"purchased_p":{"type":"number","description":"The purchase price summed up."},"lv":{"type":"number","description":"The local value summed up."},"purchased_q":{"type":"integer","description":"The number of purchases."},"abandoned_p":{"type":"number","description":"The abandoned purchase price summed up."},"abandoned_q":{"type":"integer","description":"The number of abandoned purchases."},"fmt_purchased_q":{"type":"string","description":"The number of purchases as a formatted string."},"fmt_purchased_p":{"type":"string","description":"The purchase price summed up as a formatted string."},"fmt_assisted_q":{"type":"string","description":"The number of assisted purchases as a formatted string."},"fmt_assisted_p":{"type":"string","description":"The summed value of assited purchases as a formatted string."},"fmt_abandoned_q":{"type":"string","description":"The number of abandoned purchases as a formatted string."},"fmt_abandoned_p":{"type":"string","description":"The abandoned purchase price summed up as a formatted string."},"fmt_v":{"type":"string","description":"The summed value of the local value as a formatted string."},"fmt_cp":{"type":"string","description":"The summed value of the cart price as a formatted string."},"products":{"type":"string","description":"The products used in the campaign."},"tmti_text":{"type":"string","description":"The trigger stage for the campaign."},"tmtk":{"type":"string","description":"The trigger id used with the campaign.","nullable":true},"campaign_id":{"type":"string","description":"The campaigns identifier.","nullable":true},"source":{"type":"string","description":"The campaigns source.","nullable":true},"link_id":{"type":"string","description":"The campaigns tracked link identifier.","nullable":true},"tmcs":{"type":"string","description":"The slug/id for the content used with the campaign.","nullable":true},"tmsl":{"type":"string","description":"The slot id used with the campaign.","nullable":true},"attributions":{"type":"object","description":"Any attributions to the campaign."},"last_click":{"type":"string","description":"The campaigns last click source.","nullable":true}}},"inline_response_200_1_cart":{"type":"object","properties":{"qty":{"type":"integer","description":"Number of items in the cart","example":1},"cv":{"type":"number","description":"Cart Value, as a number","example":134},"cart_id":{"type":"string","description":"Unique cart id, if known","example":"8f783585-1d59-45a5-b9a9-a9cb38a7683d"},"curr":{"type":"string","description":"Currency - ISO 4217 currency code","example":"USD"},"sbr":{"type":"string","description":"Site Brand/Territory for the product (e.g. the product was shown in USD on the US version of the store)","example":"DEMO"},"p":{"$ref":"#/components/schemas/Product"}}},"inline_response_200_1_results":{"required":["_id","abandoned_p","abandoned_q","attributions","campaign_id","fmt_abandoned_p","fmt_abandoned_q","fmt_assisted_p","fmt_assisted_q","fmt_cp","fmt_purchased_p","fmt_purchased_q","fmt_v","last_click","link_id","lv","products","purchased_p","purchased_q","source","tmcs","tmsl","tmti_text","tmtk"],"type":"object","properties":{"_id":{"type":"string","description":"The unique id of the record.","nullable":true},"o_num":{"type":"string","description":"The order number for the conversion."},"assists":{"type":"array","description":"Any associated assists the campaign generated.","items":{"$ref":"#/components/schemas/assistDetails"}},"attributions":{"type":"array","description":"Any attributions associated with the campaign.","items":{"$ref":"#/components/schemas/attributionDetails"}},"cart":{"$ref":"#/components/schemas/inline_response_200_1_cart"},"dt":{"type":"string","description":"When the purchase was made in UTC ISO-8601 format.","format":"date-time"},"email":{"type":"string","description":"The email of the customer.","format":"email"},"pid":{"type":"string","description":"The unique person id for the customer."},"q":{"type":"object","description":"Any tracking query parameters."},"v":{"type":"number","description":"The local value."},"assist_tmsb":{"type":"string","description":"The SmartBlock id that caused the assist."},"attrib_tmsb":{"type":"string","description":"The SmartBlock id that caused the attribution."},"fmt_purchased_q":{"type":"string","description":"The number of purchases as a formatted string."},"fmt_purchased_p":{"description":"The purchase price summed up as a formatted string."},"fmt_assisted_q":{"type":"string","description":"The number of assisted purchases as a formatted string."},"fmt_assisted_p":{"description":"The purchase price of the assisted purchases as a formatted string."},"fmt_abandoned_q":{"type":"string","description":"The number of abandoned purchases as a formatted string."},"fmt_abandoned_p":{"type":"string","description":"The abandoned purchase price summed up as a formatted string."},"fmt_v":{"type":"string","description":"The summed value of the local value as a formatted string."},"fmt_cp":{"type":"string","description":"The summed value of the cart price as a formatted string."},"products":{"type":"string","description":"The products used in the campaign."},"product_0_prid":{"type":"string","description":"The product id for item 0."},"product_0_n":{"type":"string","description":"The product name for item 0."},"product_0_uv":{"type":"number","description":"The unit valie for item 0."},"product_0_qty":{"type":"integer","description":"The quantity of item 0."},"tmti_text":{"type":"string","description":"The trigger stage for the campaign."},"tmtk":{"type":"string","description":"The trigger id used with the campaign.","nullable":true},"campaign_id":{"type":"string","description":"The campaigns identifier.","nullable":true},"source":{"type":"string","description":"The campaigns source.","nullable":true},"link_id":{"type":"string","description":"The campaigns tracked link identifier.","nullable":true},"tmcs":{"type":"string","description":"The slug/id for the content used with the campaign.","nullable":true},"tmsl":{"type":"string","description":"The slot id used with the campaign.","nullable":true},"last_click":{"type":"string","description":"The campaigns last click source.","nullable":true}}},"inline_response_200_2__id":{"required":["day_of_year"],"type":"object","properties":{"day_of_year":{"maxItems":2,"minItems":2,"type":"array","example":[90,2024],"items":{"type":"integer"}}},"description":"The unique id of the record."},"inline_response_200_2_abandoned":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Abandonments daily summary."},"inline_response_200_2_purchased":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Purchases daily summary."},"inline_response_200_2_recovered":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Recoveries daily summary."},"inline_response_200_2_results":{"required":["_id","abandoned","as_p_p","as_p_q","at_p_p","at_p_q","b_p_i","b_p_ni","b_q_i","b_q_ni","ba_q","ba_q_i","ba_q_ni","count","cspv","ct","cu_q_i","cu_q_ni","dt","fmt_abv_abandoned","fmt_abv_purchased","fmt_abv_recovered","fmt_as_p_p","fmt_as_p_q","fmt_at_p_p","fmt_at_p_q","fmt_b_identification_rate","fmt_b_p","fmt_b_q","fmt_ba_identification_rate","fmt_ba_q","fmt_cspv","fmt_ct","fmt_dt","fmt_imp","fmt_ms_b_q","fmt_ms_ba_q","fmt_ms_ca_b_q","fmt_ms_ca_ba_q","fmt_ms_ca_cu_q","fmt_ms_ca_pcs_q","fmt_ms_ca_pcv_q","fmt_ms_cu_q","fmt_ms_pcs_q","fmt_ms_pcv_q","fmt_ms_q","fmt_p_p","fmt_p_q","fmt_percent_abandoned","fmt_percent_abandoned_all_sessions","fmt_percent_recovered","fmt_pq_conversion_rate","fmt_purchased_rate","fmt_pv","fmt_rec_b_p","fmt_rec_b_q","fmt_rec_ba_p","fmt_rec_ba_q","fmt_rec_cu_p","fmt_rec_cu_q","fmt_rec_p","fmt_rec_pcs_p","fmt_rec_pcs_q","fmt_rec_pcv_p","fmt_rec_pcv_q","fmt_rec_q","fmt_recovered_rate","fmt_sales_uplift","fmt_sq","fmt_tpv","imp","ms_b_q","ms_ba_q","ms_ca_b_q","ms_ca_ba_q","ms_ca_cu_q","ms_ca_pcs_q","ms_ca_pcv_q","ms_cu_q","ms_pcls_q","ms_pcs_q","ms_pcv_q","ms_q","p_p","p_q","purchased","pv","rec_b_p","rec_b_q","rec_ba_p","rec_ba_q","rec_cu_p","rec_cu_q","rec_p","rec_pcls_p","rec_pcls_q","rec_pcs_p","rec_pcs_q","rec_pcv_p","rec_pcv_q","rec_q","rec_t_p","rec_t_q","recovered","sb_p_p","sb_p_q","sq","tpv"],"type":"object","properties":{"_id":{"$ref":"#/components/schemas/inline_response_200_2__id"},"abandoned":{"$ref":"#/components/schemas/inline_response_200_2_abandoned"},"as_p_p":{"type":"number","description":"Assisted purchase value."},"as_p_q":{"type":"integer","description":"Assisted purchase quantity."},"at_p_p":{"type":"number","description":"Attributed purchase value."},"at_p_q":{"type":"integer","description":"Attributed purchase quantity."},"b_p_i":{"type":"number","description":"Cart abandonment value identified."},"b_p_ni":{"type":"number","description":"Cart abandonment value not identified."},"b_q_i":{"type":"integer","description":"Cart abandonment quantity identified."},"b_q_ni":{"type":"integer","description":"Cart abandonment quantity not identified."},"ba_q":{"type":"integer","description":"Browse abandonment quantity."},"ba_q_i":{"type":"integer","description":"Browse abandonment quantity identified."},"ba_q_ni":{"type":"integer","description":"Browse abandonment quantity not identified."},"count":{"type":"integer","description":"Count of all conversions"},"cspv":{"type":"integer","description":"Content server page views."},"ct":{"type":"integer","description":"Click-throughs"},"cu_q_i":{"type":"integer","description":"Custom signal quantity identified."},"cu_q_ni":{"type":"integer","description":"Custom signal quantity not identified."},"dt":{"type":"string","description":"Date in UTC the conversion stats are for in ISO-8601 format.","format":"date-time"},"fmt_abv_abandoned":{"type":"string","description":"Formatted for display average abandoned value."},"fmt_abv_purchased":{"type":"string","description":"Formatted for display average purchased value."},"fmt_abv_recovered":{"type":"string","description":"Formatted for display average recovered value."},"fmt_as_p_p":{"type":"string","description":"Formatted for display assisted purchases value."},"fmt_as_p_q":{"type":"string","description":"Formatted for display assisted purchases."},"fmt_at_p_p":{"type":"string","description":"Formatted for display attributed purchases value."},"fmt_at_p_q":{"type":"string","description":"Formatted for display attributed purchases."},"fmt_b_identification_rate":{"type":"string","description":"Formatted for display cart abandonment identification rate percentage."},"fmt_b_p":{"type":"string","description":"Formatted for display abandonment value."},"fmt_b_q":{"type":"string","description":"Formatted for display abandonment quantity."},"fmt_ba_identification_rate":{"type":"string","description":"Formatted for display browse abandonment identification rate percentage."},"fmt_ba_q":{"type":"string","description":"Formatted for display browse abandonment quantity."},"fmt_cspv":{"type":"string","description":"Formatted for display content server page views."},"fmt_ct":{"type":"string","description":"Formatted for display click-throughs."},"fmt_dt":{"type":"string","description":"Formatted for display date."},"fmt_imp":{"type":"string","description":"Formatted for display impressions."},"fmt_ms_b_q":{"type":"string","description":"Formatted for display cart abandonment messages sent."},"fmt_ms_ba_q":{"type":"string","description":"Formatted for display browse abandonment messages sent."},"fmt_ms_ca_b_q":{"type":"string","description":"Formatted for display cart abandonment catch all messages sent."},"fmt_ms_ca_ba_q":{"type":"string","description":"Formatted for display browse abandonment catch all messages sent."},"fmt_ms_ca_cu_q":{"type":"string","description":"Formatted for display custom signal catch all messages sent."},"fmt_ms_ca_pcs_q":{"type":"string","description":"Formatted for display product stock change catch all messages sent."},"fmt_ms_ca_pcv_q":{"type":"string","description":"Formatted for display product change value catch all messages sent."},"fmt_ms_cu_q":{"type":"string","description":"Formatted for display custom signal messages sent."},"fmt_ms_pcs_q":{"type":"string","description":"Formatted for display product stock change messages sent."},"fmt_ms_pcv_q":{"type":"string","description":"Formatted for display product change value messages sent."},"fmt_ms_q":{"type":"string","description":"Formatted for display messages sent."},"fmt_p_p":{"type":"string","description":"Formatted for display purchased value."},"fmt_p_q":{"type":"string","description":"Formatted for display purchased quantity."},"fmt_percent_abandoned":{"type":"string","description":"Formatted for display abandoned percentage."},"fmt_percent_abandoned_all_sessions":{"type":"string","description":"Formatted for display abandoned percentage for all sessions."},"fmt_percent_recovered":{"type":"string","description":"Formatted for display recovered percentage."},"fmt_pq_conversion_rate":{"description":"Formatted for display purchase rate percentage."},"fmt_purchased_rate":{"type":"string","description":"Formatted for display purchased rate percentage."},"fmt_pv":{"type":"string","description":"Formatted for display page views."},"fmt_rec_b_p":{"type":"string","description":"Formatted for display recovered cart abandonment value."},"fmt_rec_b_q":{"type":"string","description":"Formatted for display recovered cart abandonment quantity."},"fmt_rec_ba_p":{"type":"string","description":"Formatted for display recovered browse abandonment value."},"fmt_rec_ba_q":{"type":"string","description":"Formatted for display recovered browse abandonment quantity."},"fmt_rec_cu_p":{"type":"string","description":"Formatted for display recovered custom signal value."},"fmt_rec_cu_q":{"type":"string","description":"Formatted for display recovered custom signal quantity."},"fmt_rec_p":{"type":"string","description":"Formatted for display recovered value."},"fmt_rec_pcs_p":{"type":"string","description":"Formatted for display recovered product stock signal value."},"fmt_rec_pcs_q":{"type":"string","description":"Formatted for display recovered product stock signal quantity."},"fmt_rec_pcv_p":{"type":"string","description":"Formatted for display recovered product change value signal value."},"fmt_rec_pcv_q":{"type":"string","description":"Formatted for display recovered product change value signal quantity."},"fmt_rec_q":{"type":"string","description":"Formatted for display recovered quantity."},"fmt_recovered_rate":{"type":"string","description":"Formatted for display recovered rate percentage."},"fmt_sales_uplift":{"type":"string","description":"Formatted for display sales uplift percentage."},"fmt_sq":{"type":"string","description":"Formatted for display sessions."},"fmt_tpv":{"type":"string","description":"Formatted for display total page views."},"imp":{"type":"integer","description":"Impressions"},"ms_b_q":{"type":"integer","description":"Cart abandonment messages sent."},"ms_ba_q":{"type":"integer","description":"Browse abandonment messages sent."},"ms_ca_b_q":{"type":"integer","description":"Cart abandonment catch all messages sent."},"ms_ca_ba_q":{"type":"integer","description":"Browse abandonment catch all messages sent."},"ms_ca_cu_q":{"type":"integer","description":"Custom signal catch all messages sent."},"ms_ca_pcs_q":{"type":"integer","description":"Product stock change catch all messages sent."},"ms_ca_pcv_q":{"type":"integer","description":"Product value change catch all messages sent."},"ms_cu_q":{"type":"integer","description":"Custom signal messages sent."},"ms_pcls_q":{"type":"integer","description":"Product low stock messages sent."},"ms_pcs_q":{"type":"integer","description":"Product stock change messages sent."},"ms_pcv_q":{"type":"integer","description":"Product value change messages sent."},"ms_q":{"type":"integer","description":"Messages sent quantity."},"p_p":{"type":"number","description":"Purchased value."},"p_q":{"type":"integer","description":"Purchased quantity."},"purchased":{"$ref":"#/components/schemas/inline_response_200_2_purchased"},"pv":{"type":"integer","description":"Page views."},"rec_b_p":{"type":"number","description":"Recovered abandoned cart value."},"rec_b_q":{"type":"integer","description":"Recovered abandoned cart quantity."},"rec_ba_p":{"type":"number","description":"Recovered abandoned browse value."},"rec_ba_q":{"type":"integer","description":"Recovered abandoned browse quantity."},"rec_cu_p":{"type":"number","description":"Recovered custom signal value."},"rec_cu_q":{"type":"integer","description":"Recovered custom signal quantity."},"rec_p":{"type":"number","description":"Recovered value."},"rec_pcls_p":{"type":"number","description":"Recovered product low stock signal value."},"rec_pcls_q":{"type":"integer","description":"Recovered product low stock signal quantity."},"rec_pcs_p":{"type":"number","description":"Recovered product stock change signal value."},"rec_pcs_q":{"type":"integer","description":"Recovered product stock change signal quantity."},"rec_pcv_p":{"type":"number","description":"Recovered product value change signal value."},"rec_pcv_q":{"type":"integer","description":"Recovered product value change signal quantity."},"rec_q":{"type":"integer","description":"Recovered quantity."},"rec_t_p":{"type":"number","description":"Recovered purchase complete value."},"rec_t_q":{"type":"integer","description":"Recovered purchase complete quantity."},"recovered":{"$ref":"#/components/schemas/inline_response_200_2_recovered"},"sb_p_p":{"type":"number","description":"Smartblock purchase value."},"sb_p_q":{"type":"integer","description":"Smartblock purchase quantity."},"sq":{"type":"integer","description":"Sessions."},"tpv":{"type":"integer","description":"Total page views."}}},"inline_response_200_2_oColumnTotals_abandoned":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Abandonments daily summary total total."},"inline_response_200_2_oColumnTotals_purchased":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Purchases daily summary total."},"inline_response_200_2_oColumnTotals_recovered":{"required":["count","value"],"type":"object","properties":{"count":{"type":"integer","description":"Quantity"},"value":{"type":"number","description":"Cash value"}},"description":"Recoveries daily summary total."},"inline_response_200_2_oColumnTotals":{"required":["abandoned","as_p_p","as_p_q","at_p_p","at_p_q","b_p_i","b_p_ni","b_q_i","b_q_ni","ba_q","ba_q_i","ba_q_ni","count","cspv","ct","cu_q_i","cu_q_ni","fmt_abv_abandoned","fmt_abv_purchased","fmt_abv_recovered","fmt_as_p_p","fmt_as_p_q","fmt_at_p_p","fmt_at_p_q","fmt_b_identification_rate","fmt_b_p","fmt_b_q","fmt_ba_identification_rate","fmt_ba_q","fmt_cspv","fmt_ct","fmt_dt","fmt_imp","fmt_ms_b_q","fmt_ms_ba_q","fmt_ms_ca_b_q","fmt_ms_ca_ba_q","fmt_ms_ca_cu_q","fmt_ms_ca_pcs_q","fmt_ms_ca_pcv_q","fmt_ms_cu_q","fmt_ms_pcs_q","fmt_ms_pcv_q","fmt_ms_q","fmt_p_p","fmt_p_q","fmt_percent_abandoned","fmt_percent_abandoned_all_sessions","fmt_percent_recovered","fmt_pq_conversion_rate","fmt_purchased_rate","fmt_pv","fmt_rec_b_p","fmt_rec_b_q","fmt_rec_ba_p","fmt_rec_ba_q","fmt_rec_cu_p","fmt_rec_cu_q","fmt_rec_p","fmt_rec_pcs_p","fmt_rec_pcs_q","fmt_rec_pcv_p","fmt_rec_pcv_q","fmt_rec_q","fmt_recovered_rate","fmt_sales_uplift","fmt_sq","fmt_tpv","imp","ms_b_q","ms_ba_q","ms_ca_b_q","ms_ca_ba_q","ms_ca_cu_q","ms_ca_pcs_q","ms_ca_pcv_q","ms_cu_q","ms_pcls_q","ms_pcs_q","ms_pcv_q","ms_q","p_p","p_q","purchased","pv","rec_b_p","rec_b_q","rec_ba_p","rec_ba_q","rec_cu_p","rec_cu_q","rec_p","rec_pcls_p","rec_pcls_q","rec_pcs_p","rec_pcs_q","rec_pcv_p","rec_pcv_q","rec_q","rec_t_p","rec_t_q","recovered","sb_p_p","sb_p_q","sq","tpv"],"type":"object","properties":{"abandoned":{"$ref":"#/components/schemas/inline_response_200_2_oColumnTotals_abandoned"},"as_p_p":{"type":"number","description":"Assisted purchase value total."},"as_p_q":{"type":"integer","description":"Assisted purchase quantity total."},"at_p_p":{"type":"number","description":"Attributed purchase value total."},"at_p_q":{"type":"integer","description":"Attributed purchase quantity total."},"b_p_i":{"type":"number","description":"Cart abandonment value identified total."},"b_p_ni":{"type":"number","description":"Cart abandonment value not identified total."},"b_q_i":{"type":"integer","description":"Cart abandonment quantity identified total."},"b_q_ni":{"type":"integer","description":"Cart abandonment quantity not identified total."},"ba_q":{"type":"integer","description":"Browse abandonment quantity total."},"ba_q_i":{"type":"integer","description":"Browse abandonment quantity identified total."},"ba_q_ni":{"type":"integer","description":"Browse abandonment quantity not identified total."},"count":{"type":"integer","description":"Count of all conversions"},"cspv":{"type":"integer","description":"Content server page views total."},"ct":{"type":"integer","description":"Click-throughs"},"cu_q_i":{"type":"integer","description":"Custom signal quantity identified total."},"cu_q_ni":{"type":"integer","description":"Custom signal quantity not identified total."},"fmt_abv_abandoned":{"type":"string","description":"Formatted for display average abandoned value total."},"fmt_abv_purchased":{"type":"string","description":"Formatted for display average purchased value total."},"fmt_abv_recovered":{"type":"string","description":"Formatted for display average recovered value total."},"fmt_as_p_p":{"type":"string","description":"Formatted for display assisted purchases value total."},"fmt_as_p_q":{"type":"string","description":"Formatted for display assisted purchases total."},"fmt_at_p_p":{"type":"string","description":"Formatted for display attributed purchases value total."},"fmt_at_p_q":{"type":"string","description":"Formatted for display attributed purchases total."},"fmt_b_identification_rate":{"type":"string","description":"Formatted for display cart abandonment identification rate percentage total."},"fmt_b_p":{"type":"string","description":"Formatted for display abandonment value total."},"fmt_b_q":{"type":"string","description":"Formatted for display abandonment quantity total."},"fmt_ba_identification_rate":{"type":"string","description":"Formatted for display browse abandonment identification rate percentage total."},"fmt_ba_q":{"type":"string","description":"Formatted for display browse abandonment quantity total."},"fmt_cspv":{"type":"string","description":"Formatted for display content server page views total."},"fmt_ct":{"type":"string","description":"Formatted for display click-throughs total."},"fmt_dt":{"type":"string","description":"Formatted for display date total."},"fmt_imp":{"type":"string","description":"Formatted for display impressions total."},"fmt_ms_b_q":{"type":"string","description":"Formatted for display cart abandonment messages sent total."},"fmt_ms_ba_q":{"type":"string","description":"Formatted for display browse abandonment messages sent total."},"fmt_ms_ca_b_q":{"type":"string","description":"Formatted for display cart abandonment catch all messages sent total."},"fmt_ms_ca_ba_q":{"type":"string","description":"Formatted for display browse abandonment catch all messages sent total."},"fmt_ms_ca_cu_q":{"type":"string","description":"Formatted for display custom signal catch all messages sent total."},"fmt_ms_ca_pcs_q":{"type":"string","description":"Formatted for display product stock change catch all messages sent total."},"fmt_ms_ca_pcv_q":{"type":"string","description":"Formatted for display product change value catch all messages sent total."},"fmt_ms_cu_q":{"type":"string","description":"Formatted for display custom signal messages sent total."},"fmt_ms_pcs_q":{"type":"string","description":"Formatted for display product stock change messages sent total."},"fmt_ms_pcv_q":{"type":"string","description":"Formatted for display product change value messages sent total."},"fmt_ms_q":{"type":"string","description":"Formatted for display messages sent total."},"fmt_p_p":{"type":"string","description":"Formatted for display purchased value total."},"fmt_p_q":{"type":"string","description":"Formatted for display purchased quantity total."},"fmt_percent_abandoned":{"type":"string","description":"Formatted for display abandoned percentage total."},"fmt_percent_abandoned_all_sessions":{"type":"string","description":"Formatted for display abandoned percentage for all sessions total."},"fmt_percent_recovered":{"type":"string","description":"Formatted for display recovered percentage total."},"fmt_pq_conversion_rate":{"description":"Formatted for display purchase rate percentage total."},"fmt_purchased_rate":{"type":"string","description":"Formatted for display purchased rate percentage total."},"fmt_pv":{"type":"string","description":"Formatted for display page views total."},"fmt_rec_b_p":{"type":"string","description":"Formatted for display recovered cart abandonment value total."},"fmt_rec_b_q":{"type":"string","description":"Formatted for display recovered cart abandonment quantity total."},"fmt_rec_ba_p":{"type":"string","description":"Formatted for display recovered browse abandonment value total."},"fmt_rec_ba_q":{"type":"string","description":"Formatted for display recovered browse abandonment quantity total."},"fmt_rec_cu_p":{"type":"string","description":"Formatted for display recovered custom signal value total."},"fmt_rec_cu_q":{"type":"string","description":"Formatted for display recovered custom signal quantity total."},"fmt_rec_p":{"type":"string","description":"Formatted for display recovered value total."},"fmt_rec_pcs_p":{"type":"string","description":"Formatted for display recovered product stock signal value total."},"fmt_rec_pcs_q":{"type":"string","description":"Formatted for display recovered product stock signal quantity total."},"fmt_rec_pcv_p":{"type":"string","description":"Formatted for display recovered product change value signal value total."},"fmt_rec_pcv_q":{"type":"string","description":"Formatted for display recovered product change value signal quantity total."},"fmt_rec_q":{"type":"string","description":"Formatted for display recovered quantity total."},"fmt_recovered_rate":{"type":"string","description":"Formatted for display recovered rate percentage total."},"fmt_sales_uplift":{"type":"string","description":"Formatted for display sales uplift percentage total."},"fmt_sq":{"type":"string","description":"Formatted for display sessions total."},"fmt_tpv":{"type":"string","description":"Formatted for display total page views total."},"imp":{"type":"integer","description":"Impressions"},"ms_b_q":{"type":"integer","description":"Cart abandonment messages sent total."},"ms_ba_q":{"type":"integer","description":"Browse abandonment messages sent total."},"ms_ca_b_q":{"type":"integer","description":"Cart abandonment catch all messages sent total."},"ms_ca_ba_q":{"type":"integer","description":"Browse abandonment catch all messages sent total."},"ms_ca_cu_q":{"type":"integer","description":"Custom signal catch all messages sent total."},"ms_ca_pcs_q":{"type":"integer","description":"Product stock change catch all messages sent total."},"ms_ca_pcv_q":{"type":"integer","description":"Product value change catch all messages sent total."},"ms_cu_q":{"type":"integer","description":"Custom signal messages sent total."},"ms_pcls_q":{"type":"integer","description":"Product low stock messages sent total."},"ms_pcs_q":{"type":"integer","description":"Product stock change messages sent total."},"ms_pcv_q":{"type":"integer","description":"Product value change messages sent total."},"ms_q":{"type":"integer","description":"Messages sent quantity total."},"p_p":{"type":"number","description":"Purchased value total."},"p_q":{"type":"integer","description":"Purchased quantity total."},"purchased":{"$ref":"#/components/schemas/inline_response_200_2_oColumnTotals_purchased"},"pv":{"type":"integer","description":"Page views total."},"rec_b_p":{"type":"number","description":"Recovered abandoned cart value total."},"rec_b_q":{"type":"integer","description":"Recovered abandoned cart quantity total."},"rec_ba_p":{"type":"number","description":"Recovered abandoned browse value total."},"rec_ba_q":{"type":"integer","description":"Recovered abandoned browse quantity total."},"rec_cu_p":{"type":"number","description":"Recovered custom signal value total."},"rec_cu_q":{"type":"integer","description":"Recovered custom signal quantity total."},"rec_p":{"type":"number","description":"Recovered value total."},"rec_pcls_p":{"type":"number","description":"Recovered product low stock signal value total."},"rec_pcls_q":{"type":"integer","description":"Recovered product low stock signal quantity total."},"rec_pcs_p":{"type":"number","description":"Recovered product stock change signal value total."},"rec_pcs_q":{"type":"integer","description":"Recovered product stock change signal quantity total."},"rec_pcv_p":{"type":"number","description":"Recovered product value change signal value total."},"rec_pcv_q":{"type":"integer","description":"Recovered product value change signal quantity total."},"rec_q":{"type":"integer","description":"Recovered quantity total."},"rec_t_p":{"type":"number","description":"Recovered purchase complete value total."},"rec_t_q":{"type":"integer","description":"Recovered purchase complete quantity total."},"recovered":{"$ref":"#/components/schemas/inline_response_200_2_oColumnTotals_recovered"},"sb_p_p":{"type":"number","description":"Smartblock purchase value total."},"sb_p_q":{"type":"integer","description":"Smartblock purchase quantity total."},"sq":{"type":"integer","description":"Sessions total."},"tpv":{"type":"integer","description":"Total page views total."}},"description":"Totaled values for the data page."},"inline_response_200_3_results":{"required":["cart","dt","email","id","mobile","pid","q","type","v"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record."},"pid":{"type":"string","description":"The unique person id this cart belonged to."},"dt":{"type":"string","description":"The date time this cart was abandoned is UTC ISO-8601 format.","format":"date-time"},"cart":{"allOf":[{"description":"The abondoned cart details."},{"$ref":"#/components/schemas/CartContents"}]},"email":{"type":"string","description":"The email address of the cart owner.","format":"email","nullable":true},"mobile":{"type":"string","description":"The mobile number in E.164 format of the cart owner.","nullable":true},"v":{"type":"number","description":"The value of the cart.","nullable":true},"q":{"type":"object","description":"Any query parameters","nullable":true},"type":{"type":"string","description":"The type id of abandonment:\n* b - browse abadonment\n* ba - basket abandonment\n","enum":["b","ba"]}}},"inline_response_200_3_headers":{"required":["cart.cp","cart.curr","cart.p.0.n","cart.p.0.prid","cart.p.0.qty","cart.p.0.up","cart.p.1.n","cart.p.1.prid","cart.p.1.qty","cart.p.1.up","cart.p.2.n","cart.p.2.prid","cart.p.2.qty","cart.p.2.up","cart.sbr","cart.u","dt","email","mobile","q.campaign_id","q.link_id","q.source","v"],"type":"object","properties":{"dt":{"type":"string","description":"The terminolgy to use for this."},"v":{"type":"string","description":"The terminolgy to use for this."},"cart.cp":{"type":"string","description":"The terminolgy to use for this."},"cart.curr":{"type":"string","description":"The terminolgy to use for this."},"email":{"type":"string","description":"The terminolgy to use for this."},"mobile":{"type":"string","description":"The terminolgy to use for this."},"q.campaign_id":{"type":"string","description":"The terminolgy to use for this."},"q.link_id":{"type":"string","description":"The terminolgy to use for this."},"q.source":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.sbr":{"type":"string","description":"The terminolgy to use for this."},"cart.u":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_4_b_signal":{"required":["cart","dt","evdt","type"],"type":"object","properties":{"dt":{"type":"string","description":"The date time the signal occured in UTC ISO-8601 format.","format":"date-time"},"type":{"type":"string","description":"The type id of signal:\n* b - browse abadonment\n* ba - basket abandonment\n","enum":["b","ba"]},"evdt":{"type":"string","description":"The date time the event in UTC ISO-8601 format.","format":"date-time"},"cart":{"allOf":[{"description":"The cart details."},{"$ref":"#/components/schemas/CartContents"}]}},"description":"Details of the signal that caused the recovery."},"inline_response_200_4_results":{"required":["action_index","b_signal","cart","dt","email","id","key","mobile","o_num","pid","program_type","q","v"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record."},"pid":{"type":"string","description":"The unique person id this cart belonged to."},"dt":{"type":"string","description":"The date time this cart was recovered is UTC ISO-8601 format.","format":"date-time"},"cart":{"allOf":[{"description":"The recovered cart details."},{"$ref":"#/components/schemas/CartContents"}]},"v":{"type":"number","description":"The value of the cart.","nullable":true},"email":{"type":"string","description":"The email address of the cart owner.","format":"email","nullable":true},"mobile":{"type":"string","description":"The mobile number in E.164 format of the cart owner.","nullable":true},"b_signal":{"$ref":"#/components/schemas/inline_response_200_4_b_signal"},"q":{"type":"object","description":"Any additional query parameters.","nullable":true},"o_num":{"type":"string","description":"The order number","nullable":true},"key":{"type":"string","description":"Trigger key","nullable":true},"program_type":{"type":"string","description":"The type id of abandonment:\n* b - browse abadonment\n* ba - basket abandonment\n","enum":["b","ba"]},"action_index":{"type":"integer","description":"The action index associated with the record.","nullable":true}}},"inline_response_200_4_headers":{"required":["b_signal.cart.cp","b_signal.dt","cart.cp","cart.p.0.n","cart.p.0.prid","cart.p.0.qty","cart.p.0.up","cart.p.1.n","cart.p.1.prid","cart.p.1.qty","cart.p.1.up","cart.p.2.n","cart.p.2.prid","cart.p.2.qty","cart.p.2.up","cart.sbr","cart.u","dt","email","mobile","o_num","programTypeName","q.campaign_id","q.link_id","q.source","stage","triggerName","v"],"type":"object","properties":{"dt":{"type":"string","description":"The terminolgy to use for this."},"v":{"type":"string","description":"The terminolgy to use for this."},"cart.cp":{"type":"string","description":"The terminolgy to use for this."},"email":{"type":"string","description":"The terminolgy to use for this."},"mobile":{"type":"string","description":"The terminolgy to use for this."},"b_signal.dt":{"type":"string","description":"The terminolgy to use for this."},"b_signal.cart.cp":{"type":"string","description":"The terminolgy to use for this."},"q.campaign_id":{"type":"string","description":"The terminolgy to use for this."},"q.link_id":{"type":"string","description":"The terminolgy to use for this."},"q.source":{"type":"string","description":"The terminolgy to use for this."},"triggerName":{"type":"string","description":"The terminolgy to use for this."},"programTypeName":{"type":"string","description":"The terminolgy to use for this."},"stage":{"type":"string","description":"The terminolgy to use for this."},"o_num":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.sbr":{"type":"string","description":"The terminolgy to use for this."},"cart.u":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_5_results":{"required":["assists","attributions","cart","dt","email","id","mobile","o_num","pid","q","stage","v"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record."},"pid":{"type":"string","description":"The unique person id this cart belonged to."},"dt":{"type":"string","description":"The date time this cart was recovered is UTC ISO-8601 format.","format":"date-time"},"cart":{"allOf":[{"description":"The recovered cart details."},{"$ref":"#/components/schemas/CartContents"}]},"v":{"type":"number","description":"The value of the cart.","nullable":true},"email":{"type":"string","description":"The email address of the cart owner.","format":"email","nullable":true},"mobile":{"type":"string","description":"The mobile number in E.164 format of the cart owner.","nullable":true},"q":{"type":"object","description":"Any additional query parameters.","nullable":true},"o_num":{"type":"string","description":"The order number","nullable":true},"stage":{"type":"string","description":"Stage","nullable":true},"attributions":{"type":"array","description":"Any attributions to the purchase.","items":{"$ref":"#/components/schemas/attributionDetails"}},"assists":{"type":"array","description":"Any associated assists the purchase.","items":{"$ref":"#/components/schemas/assistDetails"}}}},"inline_response_200_5_headers":{"required":["cart.cp","cart.p.0.n","cart.p.0.prid","cart.p.0.qty","cart.p.0.up","cart.p.1.n","cart.p.1.prid","cart.p.1.qty","cart.p.1.up","cart.p.2.n","cart.p.2.prid","cart.p.2.qty","cart.p.2.up","cart.sbr","cart.u","dt","email","mobile","o_num","programTypeName","q.campaign_id","q.link_id","q.source","stage","triggerName","v"],"type":"object","properties":{"dt":{"type":"string","description":"The terminolgy to use for this."},"v":{"type":"string","description":"The terminolgy to use for this."},"cart.cp":{"type":"string","description":"The terminolgy to use for this."},"email":{"type":"string","description":"The terminolgy to use for this."},"mobile":{"type":"string","description":"The terminolgy to use for this."},"q.campaign_id":{"type":"string","description":"The terminolgy to use for this."},"q.link_id":{"type":"string","description":"The terminolgy to use for this."},"q.source":{"type":"string","description":"The terminolgy to use for this."},"triggerName":{"type":"string","description":"The terminolgy to use for this."},"programTypeName":{"type":"string","description":"The terminolgy to use for this."},"stage":{"type":"string","description":"The terminolgy to use for this."},"o_num":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.sbr":{"type":"string","description":"The terminolgy to use for this."},"cart.u":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_6_results":{"required":["assists","attributions","cart","dt","email","id","mobile","o_num","pid","q","stage","v"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record.","example":"5efe01deb6c99171cf5a2d48"},"pid":{"type":"string","description":"The unique person id this cart belongs to.","example":"5efc6b9f69dee731d4201aa9"},"dt":{"type":"string","description":"The date time this cart was last seen in UTC ISO-8601 format.","format":"date-time"},"cart":{"allOf":[{"description":"The cart details."},{"$ref":"#/components/schemas/CartContents"}]},"v":{"type":"number","description":"The value of the cart.","nullable":true,"example":44.5},"email":{"type":"string","description":"The email address of the cart owner.","format":"email","nullable":true,"example":"joe.bloggs@emailsim.io"},"q":{"type":"object","description":"Any additional query parameters.","nullable":true}}},"inline_response_200_6_headers":{"required":["cart.cp","cart.p.0.n","cart.p.0.prid","cart.p.0.qty","cart.p.0.up","cart.p.1.n","cart.p.1.prid","cart.p.1.qty","cart.p.1.up","cart.p.2.n","cart.p.2.prid","cart.p.2.qty","cart.p.2.up","dt","email","v"],"type":"object","properties":{"dt":{"type":"string","description":"The terminolgy to use for this."},"v":{"type":"string","description":"The terminolgy to use for this."},"cart.cp":{"type":"string","description":"The terminolgy to use for this."},"email":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.0.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.1.prid":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.n":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.up":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.qty":{"type":"string","description":"The terminolgy to use for this."},"cart.p.2.prid":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_7_results":{"required":["dt","id","pid"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the message."},"pid":{"type":"string","description":"The unique person id this message was sent to."},"dt":{"type":"string","description":"The date time this message was sent is UTC ISO-8601 format.","format":"date-time"},"email":{"type":"string","description":"The email address sent to.","format":"email","nullable":true},"tk":{"type":"string","description":"The program trigger key that sent this message.","nullable":true},"type":{"type":"string","description":"The type id of message sent.","nullable":true},"typeString":{"type":"string","description":"The type of message described as a string.","nullable":true},"ignore_catchall":{"type":"boolean","description":"Indicates whether the message was sent ignoring catch all rules, i.e. a likely test send.","nullable":true},"action_index":{"type":"integer","description":"The action index the message was sent at.","nullable":true},"stage":{"type":"string","description":"The stage the message was sent from.","nullable":true},"triggerName":{"type":"string","description":"The name of the trigger the message was sent from.","nullable":true},"catchall":{"type":"string","description":"The corresponding catchall used to send the message if relevant.","nullable":true},"mobile":{"type":"string","description":"The mobile number in E.164 format sent to.","nullable":true},"medium_name":{"type":"string","description":"The message medium used.","nullable":true}}},"inline_response_200_7_headers":{"required":["dt","email","medium_name","mobile","stage","triggerName","typeString"],"type":"object","properties":{"email":{"type":"string","description":"The terminolgy to use for this."},"mobile":{"type":"string","description":"The terminolgy to use for this."},"medium_name":{"type":"string","description":"The terminolgy to use for this."},"dt":{"type":"string","description":"The terminolgy to use for this."},"triggerName":{"type":"string","description":"The terminolgy to use for this."},"stage":{"type":"string","description":"The terminolgy to use for this."},"typeString":{"type":"string","description":"The terminolgy to use for this."},"catchall":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_8_results":{"required":["dt","email","id"],"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the record.","nullable":true},"dt":{"type":"string","description":"The date time this unsubscribe happened in UTC ISO-8601 format.","format":"date-time"},"email":{"type":"string","description":"The email address of the unsubscriber.","format":"email","nullable":true,"example":"joe.bloggs@emailsim.io"}}},"inline_response_200_8_headers":{"required":["dt","email"],"type":"object","properties":{"dt":{"type":"string","description":"The terminolgy to use for this."},"email":{"type":"string","description":"The terminolgy to use for this."}},"description":"Key terminolgy mappings."},"inline_response_200_11_usage":{"required":["emu","euu","pageviews","wmu","wuu"],"type":"object","properties":{"emu":{"type":"integer","description":"The amount the email impressions allowance has decreased.","example":-105364},"euu":{"type":"integer","description":"The amount the email unmetered usage allowance has decreased.","example":-105364},"pageviews":{"type":"integer","description":"The amount the page views allowance has decreased.","example":-105364},"wmu":{"type":"integer","description":"The amount the web impressions allowance has decreased.","example":-105364},"wuu":{"type":"integer","description":"The amount the web unmetered usage allowance has decreased.","example":-105364}},"description":"Dotdigital Personalization allowance usage in the billable month"},"inline_response_200_12_results":{"required":["apv","as_p_p","as_p_q","as_p_rpm","as_p_rpme","ast_p_p","at_p_p","at_p_q","at_p_rpm","at_p_rpm_apv","at_p_rpme","at_p_rpmi","avt_p_p","ct","emu","imp","imp_cg","nt_c_cg","nt_c_norm","popover_dismiss","popover_shown","popover_submit","t_c_cg","t_c_norm","t_v_cg","t_v_norm","wmu"],"type":"object","properties":{"imp":{"type":"integer","description":"Impressions."},"imp_cg":{"type":"number","description":"Impressions control group."},"tmsb":{"type":"string","description":"Smartblock identifier."},"tmsl":{"type":"string","description":"Slot identifier."},"tmtk":{"type":"string","description":"Trigger identifier."},"campaign_id":{"type":"string","description":"Campaign identifier."},"exp_slugs":{"type":"string","description":"Experience identifier."},"at_p_p":{"type":"number","description":"Attributed purchase price."},"at_p_q":{"type":"integer","description":"Attributed purchase quantity."},"as_p_p":{"type":"number","description":"Assisted purchase price."},"as_p_q":{"type":"integer","description":"Assisted purchase quantity."},"ct":{"type":"integer","description":"Total click-throughs."},"wmu":{"type":"integer","description":"Web impressions."},"emu":{"type":"integer","description":"Email impressions."},"apv":{"type":"integer","description":"Attributed page views."},"t_c_norm":{"type":"number","description":"Purchase count normal."},"nt_c_norm":{"type":"number","description":"No purchase count normal."},"t_v_norm":{"type":"number","description":"Purchase value normal."},"t_c_cg":{"type":"number","description":"Purchase count control group."},"nt_c_cg":{"type":"number","description":"No purchase count control group."},"t_v_cg":{"type":"number","description":"Purchase value control group."},"popover_shown":{"type":"integer","description":"Total popovers shown."},"popover_dismiss":{"type":"integer","description":"Total popovers dismissed."},"popover_submit":{"type":"integer","description":"Total popovers submitted."},"at_p_rpm":{"type":"number","description":"Attributed price revenue per mile."},"at_p_rpme":{"type":"number","description":"Attributed price revenue per mile email."},"at_p_rpmi":{"type":"number","description":"Attributed price revenue per mile impressions."},"at_p_rpm_apv":{"type":"number","description":"Attributed price revenue per mile page views."},"as_p_rpm":{"type":"number","description":"Assisted price revenue per mile."},"as_p_rpme":{"type":"number","description":"Assisted price revenue per mile email."},"ast_p_p":{"type":"number","description":"Assisted purchase price."},"avt_p_p":{"type":"number","description":"Average purchase price."}}},"inline_response_200_13__id":{"required":["day","month","year"],"type":"object","properties":{"year":{"minimum":0,"type":"integer","description":"Year"},"month":{"maximum":12,"minimum":1,"type":"integer","description":"Month"},"day":{"maximum":31,"minimum":1,"type":"integer","description":"Day"}},"description":"The date details the analytics are for based on UTC."},"inline_response_200_13_items":{"required":["as_p_p","as_p_q","at_p_p","at_p_q","ct","emu","imp","imp_cg","ms_q","ms_q_cg","popover_dismiss","popover_shown","popover_submit","type_id","wmu"],"type":"object","properties":{"imp":{"type":"integer","description":"Impressions."},"imp_cg":{"type":"number","description":"Impressions control group."},"at_p_p":{"type":"number","description":"Attributed purchase price."},"at_p_q":{"type":"integer","description":"Attributed purchase quantity."},"as_p_p":{"type":"number","description":"Assisted purchase price."},"as_p_q":{"type":"integer","description":"Assisted purchase quantity."},"ms_q":{"type":"integer","description":"Messages sent."},"ms_q_cg":{"type":"integer","description":"Message sent control group."},"wmu":{"type":"integer","description":"Web impressions."},"emu":{"type":"integer","description":"Email impressions."},"ct":{"type":"integer","description":"Click-throughs."},"popover_shown":{"type":"integer","description":"Total popovers shown."},"popover_dismiss":{"type":"integer","description":"Total popovers dismissed."},"popover_submit":{"type":"integer","description":"Total popovers submitted."},"type_id":{"type":"object","description":"The identifier the analytics are about by entity type.","oneOf":[{"properties":{"tmsb":{"type":"string","description":"Smartblock identifier."}}},{"properties":{"tmsl":{"type":"string","description":"Slot identifier."}}},{"properties":{"tmtk":{"type":"string","description":"Trigger identifier."}}},{"properties":{"campaign_id":{"type":"string","description":"Campaign identifier."}}},{"properties":{"exp_slugs":{"type":"string","description":"Experience identifier."}}}]}}},"inline_response_200_13_results":{"required":["_id","items"],"type":"object","properties":{"_id":{"$ref":"#/components/schemas/inline_response_200_13__id"},"items":{"type":"array","description":"The analytics for ther day.","items":{"$ref":"#/components/schemas/inline_response_200_13_items"}}}}},"responses":{"ErrorResponse":{"description":"An error occurred","content":{"application/json":{"schema":{"required":["error","ok"],"type":"object","properties":{"ok":{"type":"boolean","description":"Indicates the call failed","enum":[false]},"error":{"oneOf":[{"type":"string","description":"The reason the call errored","example":"Validation error. No folder bd8eciompb7y, unable to delete"},{"type":"object","additionalProperties":{"minItems":1,"type":"array","items":{"type":"string","example":"This field may not be null."}},"description":"Fields with issues and their errors"}]}}}}}},"403Response":{"description":"Forbidden - Usually you are requesting data for a website you don't have access to."}},"parameters":{"WebsiteId":{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},"FormatCSVorJSON":{"name":"format","in":"query","description":"Get data in this format.","schema":{"type":"string","enum":["json","csv"],"default":"json"},"example":"json"},"Limit":{"name":"limit","in":"query","description":"Get this number of records to return in results array (pagination).","schema":{"minimum":1,"type":"integer","default":25},"example":50},"Page":{"name":"page","in":"query","description":"Which page of results you wish to return; First page is indexed as 1.","schema":{"type":"integer","default":1},"example":1},"FormatJson":{"name":"format","in":"query","description":"Get data in JSON format.","required":true,"schema":{"type":"string","enum":["json"]},"example":"json"}},"securitySchemes":{"apiTokenAuth":{"type":"apiKey","name":"x-api-key","in":"header"}}},"x-samples-languages":["curl","csharp","java","javascript","node","python","php","ruby"]}