{"openapi":"3.0.3","info":{"title":"Statistics API","description":"Provides access to aggregated performance statistics for Dotdigital Personalization assets. Use this API to retrieve statistical data across the account as a whole, or broken down by Smartblock, slot, trigger program, or experience. Statistics cover key engagement and performance metrics to support analysis and optimisation of personalisation campaigns.","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}/statistics/":{"get":{"tags":["Statistics"],"summary":"Get aggregated statistics","description":"This API endpoint returns the requested aggregated statistics for the Dotdigital Personalization system which allows you to see how Dotdigital Personalization is performing.","operationId":"statistics_get","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":"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":"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":"fields","in":"query","description":"The criteria for what statistics to retrieve.","required":true,"content":{"application/json":{"schema":{"required":["end","start"],"type":"object","properties":{"start":{"type":"string","description":"The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","format":"date-time"},"end":{"type":"string","description":"The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","format":"date-time"},"sv":{"type":"array","description":"A list of statistics you would like returned as a single value, for example 'onsite_purchase_value' will return the purchase value of all onsite smartblocks across the system during the specified time period.","items":{"allOf":[{"$ref":"#/components/schemas/StatisticsEnum"},{"$ref":"#/components/schemas/StatisticsCalculatedEnum"}]}},"ot":{"type":"array","description":"A list of statistics you would like returned as list of daily statistics over the time period, for example 'onsite_purchase_value' will return the purchase value for each day during the period.","items":{"allOf":[{"$ref":"#/components/schemas/StatisticsEnum"},{"$ref":"#/components/schemas/StatisticsCalculatedEnum"}]}},"bd":{"type":"array","description":"A list of statistics you would like returned as an object which details how much each item generated, for example 'onsite_purchase_value' will return an object of each onsite smartblock which generated purchase value during the defined time period.","items":{"allOf":[{"$ref":"#/components/schemas/BreakdownStatisticsEnum"},{"$ref":"#/components/schemas/BreakdownStatisticsCalculatedEnum"}]}}},"example":{"start":"2023-10-09T00:00:00","end":"2024-10-16T00:00:00","sv":["page_views_trend"],"ot":["page_views"],"bd":["smartblock_banner_impressions"]}}}}}],"responses":{"200":{"description":"Successful Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedStatistics"}},"example":{"links":{},"count":1,"total":1,"page":1,"results":[{"sv":{"data":{"page_views_trend":-45.6},"errors":{},"extra":{}},"ot":{"data":{"page_views":[[1728432000000,2],[1728518400000,8],[1728604800000,0],[1728691200000,0],[1728777600000,0],[1728864000000,7],[1728950400000,0],[1729036800000,1],[1729123200000,1],[1729209600000,4],[1729296000000,0],[1729382400000,0],[1729468800000,2],[1729555200000,0],[1729641600000,12],[1729728000000,6],[1729814400000,0],[1729900800000,0],[1729987200000,0],[1730073600000,4],[1730160000000,3],[1730246400000,2],[1730332800000,0],[1730419200000,1],[1730505600000,0],[1730592000000,0],[1730678400000,1],[1730764800000,9],[1730851200000,5],[1730937600000,0],[1731024000000,0]],"errors":{}}},"bd":{"data":{"smartblock_banner_impressions":[["eskao40",0],["534gpt4",0],["p98psq4",0],["qdoo2zu",0],["huryk5e",0],["7howxa4",0],["6t8j1u9",0],["liotmd9",0],["7al9v1k",0],["9ddlot9",0],["byb558w",0],["qv27z6o",0],["b9oofkg",0],["4qgvtum",0],["sru21nd",0],["ex0m29u",0],["atfnggp",0],["nj0k8u2",0],["4zdu9j0",0],["putp9td",0],["bdd3bfe",0],["k27asvk",0],["3x1tdna",0],["jrhru8d",0],["61uwf03",0],["aq9d66x",0],["ij4t063",0],["212reoe",0],["71wkdq6",0],["1gjbxhx",0],["j0hx3nt",0],["48iyav2",0],["kuhsm16",0],["ai6ya9m",0],["prjp6il",0],["exwaghy",0],["4ld3fk7",0],["t0bmtmx",0],["2uif84z",0],["f8vana4",0],["rhub6pr",0],["afnohdb",0],["6t054km",0],["1x1ll5r",0],["fg49e1y",0],["bwp5iot",0],["aigthtd",0],["qda2h9i",0],["6s84oul",0],["arj22i7",0],["panaqcg",0],["aa7u9zu",13],["phxr6hu",0],["lgyuh7w",0],["mjoddk3",0],["mpxl631",0],["a2y8r1z",0],["7nkggh7",0],["4otscfr",0],["k98umzo",0],["gi84j7e",10],["8pqdgtx",0],["tnno26g",0],["oj7woan",0],["p9gqxuj",0],["4qkpmep",0],["9tu6u5b",0],["nuvcndi",0],["maid2vs",0],["q38rohe",0],["1zakd4g",0],["lrd4gjl",0],["jgrk2qg",0],["e5kp539",0],["rdwlit6",0],["3baub24",2],["co3r529",0],["sv8rcr9",0],["mvj9r7t",0],["qrnn91d",0],["emrf2wd",14],["2wvf049",0],["af5vqev",0],["jaj3ch0",0],["mn8wwgn",0],["bpf5d3l",48],["te7ob6o",0],["870mb0i",0],["4mmugf5",0],["i3pdqdo",0],["dx9l1cs",13],["2q0rrpu",0],["1oj8cf6",0],["c01hg2s",0],["3ww2kqu",0],["52n5z3d",0],["ab4mdfw",2],["1xdjqew",0],["96xf424",0],["rdu0riu",0],["lz10vtb",0],["seib78h",0],["8p2qvxo",0],["808q3o0",0],["z5itr83",0],["ptmiwmk",0],["4j2d1r1",0],["fw104ri",0],["r1o9qr4",0],["hdwwni4",0],["h5rwnjg",0],["nhnt7h7",0],["5kbbo74",0],["t9arcc1",0],["786jtji",0],["3kow0mj",0],["ngrqvl3",0],["nn03fj9",0],["mgo4ctw",0],["c3nnifl",0],["oa5btxs",0],["e091iec",0],["1z5hlsa",0],["q8exf40",0],["objib9t",0],["sv6ynsg",0],["thyeadr",0],["jd4efym",0],["47pw5f9",0],["ic00tfj",0],["n0qb924",0],["ba60b4j",0],["122jf55",0],["crcfmz7",0],["2ateacx",0],["b4dklz8",0],["qkkbvvy",0],["zi3vmhh",0],["qv7cxgx",0],["ka2enrz",0],["kqybjib",0],["7c4wuxx",0],["sd9zlz8",0],["jgki7mt",2],["gq0xvkj",0],["n7lzrxs",0],["nnr49oy",0],["7n7i2i5",0],["pkitrx9",0],["hj8d6at",0],["ns3rzt7",0],["8rv0obp",1]],"errors":{}}}}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/statistics/smartblocks":{"get":{"tags":["Statistics"],"summary":"Get Smartblock statistics","description":"This API endpoint returns the requested information and statistics for all Smartblocks. When filtered it will return the requested information and statistics for Smartblocks matching the filters.","operationId":"statistics.smartblocks.get","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":"start","in":"query","description":"The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'.","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'.","required":true,"schema":{"type":"string"}},{"name":"statistics","in":"query","description":"A comma seperated list of statistics that you would like the API to return. At least one statistic must be requested.","required":true,"explode":false,"schema":{"type":"array","items":{"type":"string","enum":["name","status","type","impressions","unique_impressions","clickthroughs","viewed_revenue_per_mille","viewed_conversion_rate","viewed_average_order_value","viewed_purchase_count","viewed_revenue","viewed_identification_rate","viewed_bounce_rate","viewed_average_session_duration","viewed_visit_rate","viewed_sessions","viewed_revenue_per_user","viewed_revenue_per_session","attributed_revenue_per_mille","attributed_conversion_rate","attributed_average_order_value","impressions_overtime","clickthroughs_overtime","attributed_purchase_quantity_overtime","attributed_purchase_value_overtime","attributed_revenue_per_mille_overtime","attributed_conversion_rate_overtime","attributed_average_order_value_overtime","assisted_purchase_quantity_overtime","assisted_revenue_per_mille_overtime","assisted_conversion_rate_overtime","assisted_average_order_value_overtime","clickthrough_rate_overtime","unique_impressions_overtime","viewed_revenue_overtime","viewed_purchase_count_overtime","viewed_identification_rate_overtime","viewed_bounce_rate_overtime","viewed_average_session_duration_overtime","viewed_visit_rate_overtime","viewed_revenue_per_mille_overtime","viewed_conversion_rate_overtime","viewed_average_order_value_overtime","viewed_revenue_per_user_overtime","viewed_revenue_per_session_overtime"]}}},{"name":"ids","in":"query","description":"Return only Smartblocks with IDs matching one of the supplied ID's.","required":false,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"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":"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":"status","in":"query","description":"Filter on Smartblock status, the available options are 'active', 'inactive' and 'archived'.","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"metered","in":"query","description":"Filter based on whether a Smartblock is metered or unmetered","required":false,"schema":{"$ref":"#/components/schemas/Metered"}},{"name":"in_slot","in":"query","description":"Filter for Smartblocks that have been shown in the specified slot (using the slot ID)","required":false,"schema":{"type":"string"}},{"name":"smartblock_type","in":"query","description":"Filter to show only Smartblocks matching the specified smartblock type","required":false,"schema":{"type":"array","items":{"type":"string","enum":["product","banner","countdown","coupon","custom","twitter","pinterest","webcrop","popover","instagram","reviews"]}}},{"name":"name","in":"query","description":"Filter by Smartblock name, finds SmartBlock's who's names include the search string supplied","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort by statistic.","required":false,"schema":{"type":"string"}},{"name":"sort_type","in":"query","description":"Order in which to sort the results","required":false,"schema":{"type":"string","enum":["ascending","descending"]}},{"name":"folder_id","in":"query","description":"Filter for Smartblocks in a specific folder","required":false,"schema":{"type":"string"}},{"name":"optimization_test_id","in":"query","description":"Filter for Smartblock data which was part of a specific optimisation","required":false,"schema":{"type":"string"}},{"name":"overtime_interval","in":"query","description":"Interval which overtime stats are returned in. Weekly starts from first day in starts. Monthly is by calendar month.","required":false,"schema":{"type":"string","enum":["daily","weekly","monthly"]}}],"responses":{"200":{"description":"Successful Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Smartblock"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/statistics/slots":{"get":{"tags":["Statistics"],"summary":"Get Slot statistics","description":"This API endpoint returns the requested information and statistics for all Slots. When filtered it will return the requested information and statistics for Slots matching the filters.","operationId":"statistics.slots.get","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":"start","in":"query","description":"The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"statistics","in":"query","description":"A comma seperated list of statistics that you would like the API to return. At least one statistic must be requested.","required":true,"explode":false,"schema":{"type":"array","items":{"type":"string","enum":["name","status","type","impressions","unique_impressions","clickthroughs","viewed_revenue_per_mille","viewed_conversion_rate","viewed_average_order_value","viewed_purchase_count","viewed_revenue","viewed_identification_rate","viewed_bounce_rate","viewed_average_session_duration","viewed_visit_rate","viewed_average_order_value_overtime","attributed_revenue_per_mille","attributed_conversion_rate","attributed_average_order_value"]}}},{"name":"ids","in":"query","description":"Return only Slots with IDs matching one of the supplied ID's","required":false,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"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":"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":"status","in":"query","description":"Filter on Smartblock status, the available options are 'active', 'inactive' and 'archived'.","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"metered","in":"query","description":"Filter based on whether a Smartblock is metered or unmetered","required":false,"schema":{"$ref":"#/components/schemas/Metered"}},{"name":"shown_smartblock","in":"query","description":"Filter slots based on whether they have shown the supplied Smartblock (using the Smartblock ID)","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Filter by Slot name, finds Slot's who's names include the search string supplied","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort by statistic.","required":false,"schema":{"type":"string"}},{"name":"sort_type","in":"query","description":"Order in which to sort the results","required":false,"schema":{"type":"string","enum":["ascending","descending"]}},{"name":"folder_id","in":"query","description":"Filter for Slots in a specific folder","required":false,"schema":{"type":"string"}},{"name":"overtime_interval","in":"query","description":"Interval which overtime stats are returned in. Weekly starts from first day in starts. Monthly is by calendar month.","required":false,"schema":{"type":"string","enum":["daily","weekly","monthly"]}}],"responses":{"200":{"description":"Successful Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Slot"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/statistics/triggers":{"get":{"tags":["Statistics"],"summary":"Get Triggers statistics","description":"This API endpoint returns the requested information and statistics for all Triggers. When filtered it will return the requested information and statistics for Slots matching the filters.","operationId":"statistics.triggers.get","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":"start","in":"query","description":"The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"statistics","in":"query","description":"A comma seperated list of statistics that you would like the API to return. At least one statistic must be requested.","required":true,"explode":false,"schema":{"type":"array","items":{"type":"string","enum":["name","status","type","trigger_messages_sent","trigger_messages_combined_sent","trigger_persons_added","clickthroughs","attributed_revenue_per_mille","attributed_conversion_rate","attributed_average_order_value","viewed_purchase_count","viewed_revenue","viewed_identification_rate","viewed_visit_rate","viewed_revenue_per_mille","viewed_conversion_rate","viewed_average_order_value","viewed_sessions","viewed_revenue_per_user","trigger_messages_sent_overtime","trigger_messages_combined_sent_overtime","trigger_persons_added_overtime","clickthroughs_overtime","attributed_purchase_quantity_overtime","attributed_purchase_value_overtime","attributed_revenue_per_mille_overtime","attributed_conversion_rate_overtime","attributed_average_order_value_overtime","clickthrough_rate_overtime","viewed_revenue_overtime","viewed_purchase_count_overtime","viewed_identification_rate_overtime","viewed_visit_rate_overtime","viewed_conversion_rate_overtime","viewed_average_order_value_overtime","viewed_revenue_per_mille_overtime","viewed_revenue_per_user_overtime"]}}},{"name":"ids","in":"query","description":"Return only Triggers with IDs matching one of the supplied ID's","required":false,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"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":"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":"status","in":"query","description":"Filter on Smartblock status, the available options are 'active', 'inactive' and 'archived'.","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"name","in":"query","description":"Filter by Trigger name, finds Trigger's who's names include the search string supplied","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort by statistic.","required":false,"schema":{"type":"string"}},{"name":"optimization_test_id","in":"query","description":"Filter for Smartblock data which was part of a specific optimisation","required":false,"schema":{"type":"string"}},{"name":"sort_type","in":"query","description":"Order in which to sort the results","required":false,"schema":{"type":"string","enum":["ascending","descending"]}},{"name":"overtime_interval","in":"query","description":"Interval which overtime stats are returned in. Weekly starts from first day in starts. Monthly is by calendar month.","required":false,"schema":{"type":"string","enum":["daily","weekly","monthly"]}}],"responses":{"200":{"description":"Successful Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"403":{"$ref":"#/components/responses/403Response"}}}},"/{website_id}/statistics/experiences":{"get":{"tags":["Statistics"],"summary":"Get Experiences statistics","description":"This API endpoint returns the requested information and statistics for all Experiences. When filtered it will return the requested information and statistics for Experiences matching the filters.","operationId":"statistics.experiences.get","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":"start","in":"query","description":"The start date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"end","in":"query","description":"The end date of the statistics time period in ISO format date string eg '2022-01-01T00:00:00.000'","required":true,"schema":{"type":"string"}},{"name":"statistics","in":"query","description":"A comma seperated list of statistics that you would like the API to return. At least one statistic must be requested.","required":true,"explode":false,"schema":{"type":"array","items":{"type":"string","enum":["name","status","assigned","impressions","unique_impressions","clickthroughs","viewed_revenue_per_mille","viewed_conversion_rate","viewed_average_order_value","viewed_purchase_count","viewed_revenue","viewed_identification_rate","viewed_bounce_rate","viewed_average_session_duration","viewed_visit_rate","viewed_sessions","viewed_revenue_per_user","viewed_revenue_per_session","attributed_revenue_per_mille","attributed_conversion_rate","attributed_average_order_value","impressions_overtime","clickthroughs_overtime","attributed_purchase_quantity_overtime","attributed_purchase_value_overtime","attributed_revenue_per_mille_overtime","attributed_conversion_rate_overtime","attributed_average_order_value_overtime","assisted_purchase_quantity_overtime","assisted_revenue_per_mille_overtime","assisted_conversion_rate_overtime","assisted_average_order_value_overtime","clickthrough_rate_overtime","unique_impressions_overtime","viewed_revenue_overtime","viewed_purchase_count_overtime","viewed_identification_rate_overtime","viewed_bounce_rate_overtime","viewed_average_session_duration_overtime","viewed_visit_rate_overtime","viewed_revenue_per_mille_overtime","viewed_conversion_rate_overtime","viewed_revenue_per_user_overtime","viewed_revenue_per_session_overtime"]}}},{"name":"ids","in":"query","description":"Return only Expeirences with IDs matching one of the supplied ID's","required":false,"explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"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":"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":"status","in":"query","description":"Filter on Smartblock status, the available options are 'active', 'inactive' and 'archived'.","required":false,"schema":{"$ref":"#/components/schemas/Status"}},{"name":"name","in":"query","description":"Filter by Experience name, finds Experience's who's names include the search string supplied","required":false,"schema":{"type":"string"}},{"name":"optimization_test_id","in":"query","description":"Filter for Smartblock data which was part of a specific optimisation","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort by statistic.","required":false,"schema":{"type":"string"}},{"name":"sort_type","in":"query","description":"Order in which to sort the results","required":false,"schema":{"type":"string","enum":["ascending","descending"]}},{"name":"overtime_interval","in":"query","description":"Interval which overtime stats are returned in. Weekly starts from first day in starts. Monthly is by calendar month.","required":false,"schema":{"type":"string","enum":["daily","weekly","monthly"]}}],"responses":{"200":{"description":"Successful Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Experience"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Error"}}}}},"403":{"$ref":"#/components/responses/403Response"}}}}},"components":{"schemas":{"AggregatedStatistics":{"type":"object","properties":{"count":{"type":"integer","example":5},"total":{"type":"integer","example":5},"page":{"type":"integer","example":1},"links":{"$ref":"#/components/schemas/AggregatedStatistics_links"},"results":{"type":"array","items":{"$ref":"#/components/schemas/AggregatedStatistics_results"}}}},"Smartblock":{"type":"object","properties":{"ok":{"type":"boolean"},"details":{"$ref":"#/components/schemas/Smartblock_details"},"results":{"$ref":"#/components/schemas/Smartblock_results"}}},"Slot":{"type":"object","properties":{"ok":{"type":"boolean"},"details":{"$ref":"#/components/schemas/Smartblock_details"},"results":{"$ref":"#/components/schemas/Slot_results"}}},"Trigger":{"type":"object","properties":{"ok":{"type":"boolean"},"details":{"$ref":"#/components/schemas/Smartblock_details"},"results":{"$ref":"#/components/schemas/Trigger_results"}}},"Experience":{"type":"object","properties":{"ok":{"type":"boolean"},"details":{"$ref":"#/components/schemas/Smartblock_details"},"results":{"$ref":"#/components/schemas/Experience_results"}}},"Error":{"type":"object","properties":{"ok":{"type":"boolean","default":false},"error":{"type":"string","example":"An error has occured!"}}},"Status":{"type":"array","items":{"type":"string","enum":["active","inactive","archived"]}},"Metered":{"type":"boolean"},"StatisticsEnum":{"type":"string","enum":["average_browse_recovery_value","average_cart_recovery_value","average_order_value","browse_abandon_average_value","browse_abandon_purchase_value_identified","browse_abandon_purchase_value_unidentified","browse_abandon_quantity","browse_abandon_quantity_identified","browse_abandon_quantity_unidentified","browse_abandon_recovery_rate","browse_abandon_value","cart_abandon_purchase_value_identified","cart_abandon_purchase_value_unidentified","cart_abandon_quantity","cart_abandon_quantity_identified","cart_abandon_quantity_unidentified","cart_abandon_value","client_purchase_quantity","client_total_purchase_value","identified_persons","offsite_impressions","offsite_purchase_quantity","offsite_purchase_value","onsite_impressions","onsite_purchase_count","onsite_purchase_quantity","onsite_purchase_value","onsite_revenue_per_mille","page_views","session_quantity","session_quantity_identified","smartblock_impressions","smartblock_offsite_impressions","smartblock_offsite_purchase_count","smartblock_offsite_purchase_value","smartblock_offsite_revenue_per_mille","trigger_messages_sent","trigger_purchase_value","trigger_purchases","triggers_sent"]},"StatisticsCalculatedEnum":{"type":"string","enum":["average_recovery_value","browse_abandon_average_recovery_value","browse_abandon_average_recovery_value_trend","browse_abandon_rate","browse_abandon_rate_trend","browse_abandon_recovery_rate","browse_abandon_recovery_rate_trend","browse_id_rate","browse_id_rate_trend","cart_abandon_average_recovery_value","cart_abandon_average_recovery_value_trend","cart_abandon_average_value","cart_abandon_average_value_trend","cart_abandon_rate","cart_abandon_rate_trend","cart_abandon_recovery_rate","cart_abandon_recovery_rate_trend","cart_id_rate","cart_id_rate_trend","client_average_order_value","client_average_order_value_trend","client_conversion_rate","client_conversion_rate_trend","client_total_purchase_value_trend","id_rate","id_rate_trend","offsite_average_order_value","offsite_conversion_rate","offsite_conversion_rate_trend","offsite_impressions_trend","offsite_purchase_value_trend","onsite_average_order_value","onsite_average_order_value_trend","onsite_conversion_rate","onsite_conversion_rate_trend","onsite_impressions_trend","onsite_purchase_value_trend","page_views_trend","smartblock_banner_impressions","smartblock_banner_offsite_average_order_value","smartblock_banner_offsite_conversion_rate","smartblock_banner_offsite_impressions","smartblock_banner_offsite_purchase_quantity","smartblock_banner_offsite_purchase_value","smartblock_banner_offsite_revenue_per_mille","smartblock_banner_onsite_average_order_value","smartblock_banner_onsite_conversion_rate","smartblock_banner_onsite_impressions","smartblock_banner_onsite_purchase_quantity","smartblock_banner_onsite_purchase_value","smartblock_banner_onsite_revenue_per_mille","smartblock_countdown_impressions","smartblock_countdown_offsite_average_order_value","smartblock_countdown_offsite_conversion_rate","smartblock_countdown_offsite_impressions","smartblock_countdown_offsite_purchase_quantity","smartblock_countdown_offsite_purchase_value","smartblock_countdown_offsite_revenue_per_mille","smartblock_countdown_onsite_average_order_value","smartblock_countdown_onsite_conversion_rate","smartblock_countdown_onsite_impressions","smartblock_countdown_onsite_purchase_quantity","smartblock_countdown_onsite_purchase_value","smartblock_countdown_onsite_revenue_per_mille","smartblock_coupon_impressions","smartblock_coupon_offsite_average_order_value","smartblock_coupon_offsite_conversion_rate","smartblock_coupon_offsite_impressions","smartblock_coupon_offsite_purchase_quantity","smartblock_coupon_offsite_purchase_value","smartblock_coupon_offsite_revenue_per_mille","smartblock_coupon_onsite_average_order_value","smartblock_coupon_onsite_conversion_rate","smartblock_coupon_onsite_impressions","smartblock_coupon_onsite_purchase_quantity","smartblock_coupon_onsite_purchase_value","smartblock_coupon_onsite_revenue_per_mille","smartblock_custom_impressions","smartblock_custom_offsite_average_order_value","smartblock_custom_offsite_conversion_rate","smartblock_custom_offsite_impressions","smartblock_custom_offsite_purchase_quantity","smartblock_custom_offsite_purchase_value","smartblock_custom_offsite_revenue_per_mille","smartblock_custom_onsite_average_order_value","smartblock_custom_onsite_conversion_rate","smartblock_custom_onsite_impressions","smartblock_custom_onsite_purchase_quantity","smartblock_custom_onsite_purchase_value","smartblock_custom_onsite_revenue_per_mille","smartblock_instagram_impressions","smartblock_instagram_offsite_average_order_value","smartblock_instagram_offsite_conversion_rate","smartblock_instagram_offsite_impressions","smartblock_instagram_offsite_purchase_quantity","smartblock_instagram_offsite_purchase_value","smartblock_instagram_offsite_revenue_per_mille","smartblock_instagram_onsite_average_order_value","smartblock_instagram_onsite_conversion_rate","smartblock_instagram_onsite_impressions","smartblock_instagram_onsite_purchase_quantity","smartblock_instagram_onsite_purchase_value","smartblock_instagram_onsite_revenue_per_mille","smartblock_offsite_average_order_value","smartblock_offsite_average_order_value_trend","smartblock_offsite_impressions_trend","smartblock_offsite_purchase_value_trend","smartblock_offsite_purchase_value_uplift","smartblock_onsite_purchase_value_uplift","smartblock_pinterest_impressions","smartblock_pinterest_offsite_average_order_value","smartblock_pinterest_offsite_conversion_rate","smartblock_pinterest_offsite_impressions","smartblock_pinterest_offsite_purchase_quantity","smartblock_pinterest_offsite_purchase_value","smartblock_pinterest_offsite_revenue_per_mille","smartblock_pinterest_onsite_average_order_value","smartblock_pinterest_onsite_conversion_rate","smartblock_pinterest_onsite_impressions","smartblock_pinterest_onsite_purchase_quantity","smartblock_pinterest_onsite_purchase_value","smartblock_pinterest_onsite_revenue_per_mille","smartblock_popover_impressions","smartblock_popover_offsite_average_order_value","smartblock_popover_offsite_conversion_rate","smartblock_popover_offsite_impressions","smartblock_popover_offsite_purchase_quantity","smartblock_popover_offsite_purchase_value","smartblock_popover_offsite_revenue_per_mille","smartblock_popover_onsite_average_order_value","smartblock_popover_onsite_conversion_rate","smartblock_popover_onsite_impressions","smartblock_popover_onsite_purchase_quantity","smartblock_popover_onsite_purchase_value","smartblock_popover_onsite_revenue_per_mille","smartblock_product_impressions","smartblock_product_offsite_average_order_value","smartblock_product_offsite_conversion_rate","smartblock_product_offsite_impressions","smartblock_product_offsite_purchase_quantity","smartblock_product_offsite_purchase_value","smartblock_product_offsite_revenue_per_mille","smartblock_product_onsite_average_order_value","smartblock_product_onsite_conversion_rate","smartblock_product_onsite_impressions","smartblock_product_onsite_purchase_quantity","smartblock_product_onsite_purchase_value","smartblock_product_onsite_revenue_per_mille","smartblock_reviews_impressions","smartblock_reviews_offsite_average_order_value","smartblock_reviews_offsite_conversion_rate","smartblock_reviews_offsite_impressions","smartblock_reviews_offsite_purchase_quantity","smartblock_reviews_offsite_purchase_value","smartblock_reviews_offsite_revenue_per_mille","smartblock_reviews_onsite_average_order_value","smartblock_reviews_onsite_conversion_rate","smartblock_reviews_onsite_impressions","smartblock_reviews_onsite_purchase_quantity","smartblock_reviews_onsite_purchase_value","smartblock_reviews_onsite_revenue_per_mille","smartblock_twitter_impressions","smartblock_twitter_offsite_average_order_value","smartblock_twitter_offsite_conversion_rate","smartblock_twitter_offsite_impressions","smartblock_twitter_offsite_purchase_quantity","smartblock_twitter_offsite_purchase_value","smartblock_twitter_offsite_revenue_per_mille","smartblock_twitter_onsite_average_order_value","smartblock_twitter_onsite_conversion_rate","smartblock_twitter_onsite_impressions","smartblock_twitter_onsite_purchase_quantity","smartblock_twitter_onsite_purchase_value","smartblock_twitter_onsite_revenue_per_mille","smartblock_webcrop_impressions","smartblock_webcrop_offsite_average_order_value","smartblock_webcrop_offsite_conversion_rate","smartblock_webcrop_offsite_impressions","smartblock_webcrop_offsite_purchase_quantity","smartblock_webcrop_offsite_purchase_value","smartblock_webcrop_offsite_revenue_per_mille","smartblock_webcrop_onsite_average_order_value","smartblock_webcrop_onsite_conversion_rate","smartblock_webcrop_onsite_impressions","smartblock_webcrop_onsite_purchase_quantity","smartblock_webcrop_onsite_purchase_value","smartblock_webcrop_onsite_revenue_per_mille","total_page_views","trigger_average_order_value","trigger_average_order_value_trend","trigger_back_in_stock_average_order_value","trigger_back_in_stock_conversion_rate","trigger_back_in_stock_message_sent_quantity","trigger_back_in_stock_purchase_quantity","trigger_back_in_stock_purchase_value","trigger_back_in_stock_recovery_value","trigger_browse_abandon_average_order_value","trigger_browse_abandon_conversion_rate","trigger_browse_abandon_message_sent_quantity","trigger_browse_abandon_purchase_quantity","trigger_browse_abandon_purchase_value","trigger_browse_abandon_recovery_value","trigger_cart_abandon_average_order_value","trigger_cart_abandon_conversion_rate","trigger_cart_abandon_message_sent_quantity","trigger_cart_abandon_purchase_quantity","trigger_cart_abandon_purchase_value","trigger_cart_abandon_recovery_value","trigger_conversion_rate","trigger_conversion_rate_trend","trigger_custom_average_order_value","trigger_custom_conversion_rate","trigger_custom_message_sent_quantity","trigger_custom_purchase_quantity","trigger_custom_purchase_value","trigger_custom_recovery_value","trigger_low_stock_average_order_value","trigger_low_stock_conversion_rate","trigger_low_stock_message_sent_quantity","trigger_low_stock_purchase_quantity","trigger_low_stock_purchase_value","trigger_low_stock_recovery_value","trigger_messages_sent_trend","trigger_price_drop_average_order_value","trigger_price_drop_conversion_rate","trigger_price_drop_message_sent_quantity","trigger_price_drop_purchase_quantity","trigger_price_drop_purchase_value","trigger_price_drop_recovery_value","trigger_purchase_complete_average_order_value","trigger_purchase_complete_conversion_rate","trigger_purchase_complete_message_sent_quantity","trigger_purchase_complete_purchase_quantity","trigger_purchase_complete_purchase_value","trigger_purchase_complete_recovery_value","trigger_purchase_value_trend","unidentified_persons"]},"BreakdownStatisticsEnum":{"type":"string","enum":["smartblock_banner_impressions","smartblock_banner_offsite_impressions","smartblock_banner_offsite_purchase_quantity","smartblock_banner_offsite_purchase_value","smartblock_banner_onsite_impressions","smartblock_banner_onsite_purchase_quantity","smartblock_banner_onsite_purchase_value","smartblock_banner_purchase_value","smartblock_countdown_impressions","smartblock_countdown_offsite_impressions","smartblock_countdown_offsite_purchase_quantity","smartblock_countdown_offsite_purchase_value","smartblock_countdown_onsite_impressions","smartblock_countdown_onsite_purchase_quantity","smartblock_countdown_onsite_purchase_value","smartblock_countdown_purchase_value","smartblock_coupon_impressions","smartblock_coupon_offsite_impressions","smartblock_coupon_offsite_purchase_quantity","smartblock_coupon_offsite_purchase_value","smartblock_coupon_onsite_impressions","smartblock_coupon_onsite_purchase_quantity","smartblock_coupon_onsite_purchase_value","smartblock_coupon_purchase_value","smartblock_custom_impressions","smartblock_custom_offsite_impressions","smartblock_custom_offsite_purchase_quantity","smartblock_custom_offsite_purchase_value","smartblock_custom_onsite_impressions","smartblock_custom_onsite_purchase_quantity","smartblock_custom_onsite_purchase_value","smartblock_custom_purchase_value","smartblock_instagram_impressions","smartblock_instagram_offsite_impressions","smartblock_instagram_offsite_purchase_quantity","smartblock_instagram_offsite_purchase_value","smartblock_instagram_onsite_impressions","smartblock_instagram_onsite_purchase_quantity","smartblock_instagram_onsite_purchase_value","smartblock_instagram_purchase_value","smartblock_pinterest_impressions","smartblock_pinterest_offsite_impressions","smartblock_pinterest_offsite_purchase_quantity","smartblock_pinterest_offsite_purchase_value","smartblock_pinterest_onsite_impressions","smartblock_pinterest_onsite_purchase_quantity","smartblock_pinterest_onsite_purchase_value","smartblock_pinterest_purchase_value","smartblock_popover_impressions","smartblock_popover_offsite_impressions","smartblock_popover_offsite_purchase_quantity","smartblock_popover_offsite_purchase_value","smartblock_popover_onsite_impressions","smartblock_popover_onsite_purchase_quantity","smartblock_popover_onsite_purchase_value","smartblock_popover_purchase_value","smartblock_product_impressions","smartblock_product_offsite_impressions","smartblock_product_offsite_purchase_quantity","smartblock_product_offsite_purchase_value","smartblock_product_onsite_impressions","smartblock_product_onsite_purchase_quantity","smartblock_product_onsite_purchase_value","smartblock_product_purchase_value","smartblock_reviews_impressions","smartblock_reviews_offsite_impressions","smartblock_reviews_offsite_purchase_quantity","smartblock_reviews_offsite_purchase_value","smartblock_reviews_onsite_impressions","smartblock_reviews_onsite_purchase_quantity","smartblock_reviews_onsite_purchase_value","smartblock_reviews_purchase_value","smartblock_twitter_impressions","smartblock_twitter_offsite_impressions","smartblock_twitter_offsite_purchase_quantity","smartblock_twitter_offsite_purchase_value","smartblock_twitter_onsite_impressions","smartblock_twitter_onsite_purchase_quantity","smartblock_twitter_onsite_purchase_value","smartblock_twitter_purchase_value","smartblock_webcrop_impressions","smartblock_webcrop_offsite_impressions","smartblock_webcrop_offsite_purchase_quantity","smartblock_webcrop_offsite_purchase_value","smartblock_webcrop_onsite_impressions","smartblock_webcrop_onsite_purchase_quantity","smartblock_webcrop_onsite_purchase_value","smartblock_webcrop_purchase_value","trigger_back_in_stock_message_sent_quantity","trigger_back_in_stock_purchase_quantity","trigger_back_in_stock_purchase_value","trigger_back_in_stock_recovery_quantity","trigger_back_in_stock_recovery_value","trigger_browse_abandon_message_sent_quantity","trigger_browse_abandon_purchase_quantity","trigger_browse_abandon_purchase_value","trigger_browse_abandon_recovery_quantity","trigger_browse_abandon_recovery_value","trigger_cart_abandon_message_sent_quantity","trigger_cart_abandon_purchase_quantity","trigger_cart_abandon_purchase_value","trigger_cart_abandon_recovery_quantity","trigger_cart_abandon_recovery_value","trigger_custom_message_sent_quantity","trigger_custom_purchase_quantity","trigger_custom_purchase_value","trigger_custom_recovery_quantity","trigger_custom_recovery_value","trigger_price_drop_message_sent_quantity","trigger_price_drop_purchase_quantity","trigger_price_drop_purchase_value","trigger_price_drop_recovery_quantity","trigger_price_drop_recovery_value","trigger_purchase_complete_message_sent_quantity","trigger_purchase_complete_purchase_quantity","trigger_purchase_complete_purchase_value","trigger_purchase_complete_recovery_quantity","trigger_purchase_complete_recovery_value"]},"BreakdownStatisticsCalculatedEnum":{"type":"string","enum":["smartblock_banner_offsite_average_order_value","smartblock_banner_offsite_revenue_per_mille","smartblock_banner_onsite_average_order_value","smartblock_banner_onsite_revenue_per_mille","smartblock_countdown_offsite_average_order_value","smartblock_countdown_offsite_revenue_per_mille","smartblock_countdown_onsite_average_order_value","smartblock_countdown_onsite_revenue_per_mille","smartblock_coupon_offsite_average_order_value","smartblock_coupon_offsite_revenue_per_mille","smartblock_coupon_onsite_average_order_value","smartblock_coupon_onsite_revenue_per_mille","smartblock_custom_offsite_average_order_value","smartblock_custom_offsite_revenue_per_mille","smartblock_custom_onsite_average_order_value","smartblock_custom_onsite_revenue_per_mille","smartblock_instagram_offsite_average_order_value","smartblock_instagram_offsite_revenue_per_mille","smartblock_instagram_onsite_average_order_value","smartblock_instagram_onsite_revenue_per_mille","smartblock_pinterest_offsite_average_order_value","smartblock_pinterest_offsite_revenue_per_mille","smartblock_pinterest_onsite_average_order_value","smartblock_pinterest_onsite_revenue_per_mille","smartblock_popover_offsite_average_order_value","smartblock_popover_offsite_revenue_per_mille","smartblock_popover_onsite_average_order_value","smartblock_popover_onsite_revenue_per_mille","smartblock_product_offsite_average_order_value","smartblock_product_offsite_revenue_per_mille","smartblock_product_onsite_average_order_value","smartblock_product_onsite_revenue_per_mille","smartblock_reviews_offsite_average_order_value","smartblock_reviews_offsite_revenue_per_mille","smartblock_reviews_onsite_average_order_value","smartblock_reviews_onsite_revenue_per_mille","smartblock_twitter_offsite_average_order_value","smartblock_twitter_offsite_revenue_per_mille","smartblock_twitter_onsite_average_order_value","smartblock_twitter_onsite_revenue_per_mille","smartblock_webcrop_offsite_average_order_value","smartblock_webcrop_offsite_revenue_per_mille","smartblock_webcrop_onsite_average_order_value","smartblock_webcrop_onsite_revenue_per_mille","trigger_back_in_stock_average_order_value","trigger_back_in_stock_conversion_rate","trigger_browse_abandon_average_order_value","trigger_browse_abandon_conversion_rate","trigger_cart_abandon_average_order_value","trigger_cart_abandon_conversion_rate","trigger_custom_average_order_value","trigger_custom_conversion_rate","trigger_price_drop_average_order_value","trigger_price_drop_conversion_rate","trigger_purchase_complete_average_order_value","trigger_purchase_complete_conversion_rate"]},"AggregatedStatistics_links":{"type":"object","properties":{"previous":{"type":"string","example":"http://admin.freshrelevance.com/"},"next":{"type":"string","example":"http://admin.freshrelevance.com/"}}},"AggregatedStatistics_single_value_data":{"type":"object","properties":{"<requested_statistic>":{"type":"number"}}},"AggregatedStatistics_single_value":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"An error occured"}},"data":{"$ref":"#/components/schemas/AggregatedStatistics_single_value_data"}}},"AggregatedStatistics_over_time_data":{"type":"object","properties":{"<requested_statistic>":{"type":"array","items":{"type":"array","example":[1633046400000,1],"items":{"type":"number"}}}}},"AggregatedStatistics_over_time":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"An error occured"}},"data":{"$ref":"#/components/schemas/AggregatedStatistics_over_time_data"}}},"AggregatedStatistics_breakdown_data":{"type":"object","properties":{"<requested_statistic>":{"type":"array","items":{"type":"array","example":["id",1],"items":{"oneOf":[{"type":"string"},{"type":"number"}]}}}}},"AggregatedStatistics_breakdown":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string","example":"An error occured"}},"data":{"$ref":"#/components/schemas/AggregatedStatistics_breakdown_data"},"extra":{"type":"object"}}},"AggregatedStatistics_results":{"type":"object","properties":{"single_value":{"$ref":"#/components/schemas/AggregatedStatistics_single_value"},"over_time":{"$ref":"#/components/schemas/AggregatedStatistics_over_time"},"breakdown":{"$ref":"#/components/schemas/AggregatedStatistics_breakdown"}}},"Smartblock_details":{"type":"object","properties":{"count":{"type":"integer","example":625},"total_pages":{"type":"integer","example":25},"page":{"type":"integer","example":1}}},"Smartblock_results_smartblock_id":{"type":"object","properties":{"name":{"type":"string","example":"Example Smartblock"},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"product"},"impressions":{"type":"integer","example":42},"clickthroughs":{"type":"integer","example":42},"viewed_revenue_per_mille":{"type":"number","example":42},"viewed_conversion_rate":{"type":"number","example":42},"viewed_average_order_value":{"type":"number","example":42},"attributed_revenue_per_mille":{"type":"number","example":42},"attributed_conversion_rate":{"type":"number","example":42},"attributed_average_order_value":{"type":"number","example":42}}},"Smartblock_results":{"type":"object","properties":{"<smartblock_id>":{"$ref":"#/components/schemas/Smartblock_results_smartblock_id"}}},"Slot_results_slot_id":{"type":"object","properties":{"name":{"type":"string","example":"Example Slot"},"status":{"type":"string","example":"active"},"type":{"type":"string","example":"Web"},"impressions":{"type":"integer","example":42},"clickthroughs":{"type":"integer","example":42},"viewed_revenue_per_mille":{"type":"number","example":42},"viewed_conversion_rate":{"type":"number","example":42},"viewed_average_order_value":{"type":"number","example":42},"attributed_revenue_per_mille":{"type":"number","example":42},"attributed_conversion_rate":{"type":"number","example":42},"attributed_average_order_value":{"type":"number","example":42}}},"Slot_results":{"type":"object","properties":{"<slot_id>":{"$ref":"#/components/schemas/Slot_results_slot_id"}}},"Trigger_results_trigger_id":{"type":"object","properties":{"name":{"type":"string","example":"Example Trigger"},"status":{"type":"string","example":"active"},"type":{"type":"string"},"messages_sent":{"type":"integer"},"clickthroughs":{"type":"integer"}}},"Trigger_results":{"type":"object","properties":{"<trigger_id>":{"$ref":"#/components/schemas/Trigger_results_trigger_id"}}},"Experience_results_experience_id":{"type":"object","properties":{"name":{"type":"string","example":"Example Experience"},"status":{"type":"string","example":"active"},"assigned":{"type":"boolean","example":true},"impressions":{"type":"integer","example":42},"clickthroughs":{"type":"integer","example":42},"viewed_revenue_per_mille":{"type":"number","example":42},"viewed_conversion_rate":{"type":"number","example":42},"viewed_average_order_value":{"type":"number","example":42},"attributed_revenue_per_mille":{"type":"number","example":42},"attributed_conversion_rate":{"type":"number","example":42},"attributed_average_order_value":{"type":"number","example":42}}},"Experience_results":{"type":"object","properties":{"<experience_id>":{"$ref":"#/components/schemas/Experience_results_experience_id"}}}},"responses":{"403Response":{"description":"Forbidden - Usually you are requesting data for a website you don't have access to."}},"parameters":{"ChannelId":{"name":"channelId","in":"path","description":"The channel ID with it's unique hash.","required":true,"schema":{"type":"string"},"example":"CustomDataTableImport:2qk7xzb"},"TableIdParameter":{"name":"tableId","in":"path","description":"The ID of the table you want to access or modify.","required":true,"schema":{"type":"string"}},"WebsiteId":{"name":"website_id","in":"path","description":"Website ID for the account you are posting data to.","required":true,"schema":{"type":"string"},"example":"abc123"},"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},"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}},"securitySchemes":{"apiTokenAuth":{"type":"apiKey","name":"x-api-key","in":"header"}}},"x-samples-languages":["curl","csharp","java","javascript","node","python","php","ruby"]}