The response object

<!DOCTYPE html><html lang="en" style="" data-color-mode="system" class=" useReactApp isRefPage "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1734475815030"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.250.0"><meta name="readme-subdomain" content="fairing"><meta name="readme-version" content="1.0"><title>The response object</title><meta name="description" content="The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the custom..."><meta property="og:title" content="The response object"><meta property="og:description" content="The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the custom..."><meta property="og:site_name" content="Fairing"><meta name="twitter:title" content="The response object"><meta name="twitter:description" content="The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the custom..."><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"><meta name="twitter:image" content="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/f6dd52b-small-Logo-Turquoise.png" type="image/png"><link rel="canonical" href="https://docs.fairing.co/reference/the-response-object"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1734475815030"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3c3bbb6f7270425fb0a7.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.7ec459657ed5da592ee9.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.da5397756d5a59905ba1.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.71f8e165da2804376b62.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.18d649b81d088ccf8fe7.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.ad529c3d39e40f72e3f8.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.684e6481786a2c9a53de.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.e8c079b3df984cab2b40.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/734.b705fc2010420612d252.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.5f04db368eee8f70d81b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/697.c7df71558ebc8a75b523.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/73.c91a16995ea193a8705d.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/777.62bdcb0e49d755651783.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3108.471d4a1c3077afe27478.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.c1a2ae7970da644925ea.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.f038db7b1e3ac1460fe5.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.21bfe108dc2a9fd8187f.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4201.0a317d4e2bf3cde90317.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.cef380c3e211d2ea6e51.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.9802bfeceb2dceb6e206.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.9d9eb8df4877b777c42d.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9553.cb407a77300a2dd958e4.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e58189ce91340b95c433.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d035c3329df9585fa7d6.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3906.62f576269c8b3253048f.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/CustomPage.b74c02c4ec3b054bb9d5.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.979bb00f878b2fa579a6.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.3ccf9f42effebdfd9cbf.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.54cd06e135d3ee0dbc93.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.071c7febd301fb6e2a4d.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.879f8fb13a34fcccd2a3.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.05c5c00809eab74a8061.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.e0529587af8819bc68f0.js"> <link data-chunk="core-icons-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.2deb29c12d09bcad8fb2.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.f9e258d171c801c1a67d.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.da2e00e975cc6d1926d1.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.c5776db0e83892adab6f.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.2edfa94f1d90a641f339.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.3f65c21b3eb3f03cbaa5.js"> <link data-chunk="core-icons-message-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"> <link data-chunk="core-icons-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.18d649b81d088ccf8fe7.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.ef84cc15c1ff3d327657.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/777.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.71f8e165da2804376b62.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.da5397756d5a59905ba1.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.7ec459657ed5da592ee9.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.60a8dcec37a13b0b71c5.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.332d7eed7b2d976c458e.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.3c3bbb6f7270425fb0a7.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"><style title="rm-custom-css">:root{--project-color-primary:#0265DE;--project-color-inverse:#fff;--recipe-button-color:#0265DE;--recipe-button-color-hover:#013779;--recipe-button-color-active:#012046;--recipe-button-color-focus:rgba(2, 101, 222, 0.25);--recipe-button-color-disabled:#aed2fe}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#0265DE;--project-color-inverse:#fff}a{color:var(--color-link-primary,#0265de)}a:hover{color:var(--color-link-primary-darken-5,#013779)}a.text-muted:hover{color:var(--color-link-primary,#0265de)}.btn.btn-primary{background-color:#0265de}.btn.btn-primary:hover{background-color:#013779}.theme-line #hub-landing-top h2{color:#0265de}#hub-landing-top .btn:hover{color:#0265de}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#0265de}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#0265de,#004293)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#0265de}.theme-line header#hub-header #header-top .btn{background-color:#0265de}header#hub-header #header-top #header-logo{width:82px;height:24px;margin-top:8px;background-image:url(https://files.readme.io/f01dca6-fairing-logo-h-24px.svg)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#0265de}#subheader-links a.active{color:#0265de!important;box-shadow:inset 0 -2px 0 #0265de}#subheader-links a:hover{color:#0265de!important;box-shadow:inset 0 -2px 0 #0265de;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#0265de}section#hub-discuss .discussion a .discuss-body h4{color:#0265de}section#hub-discuss .discussion a:hover .discuss-body h4{color:#013779}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#0265de}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#0265de}#hub-search-results h3 em{color:#0265de}.main_background,.tag-item{background:#0265de!important}.main_background:hover{background:#013779!important}.main_color{color:#0265de!important}.border_bottom_main_color{border-bottom:2px solid #0265de}.main_color_hover:hover{color:#0265de!important}section#hub-discuss h1{color:#0265de}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#0265de;background-color:#0265de}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#013779;border-color:#013779}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#0265de;color:#0265de}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#0265de);border-color:var(--project-color-primary,#0265de)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#013779;border-color:#013779}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#0265de;fill:var(--project-color-primary,#0265de)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#0265de}.main-color-accent{border-bottom:3px solid #0265de;padding-bottom:8px}</style><meta name="loadedProject" content="fairing"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.250.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-line header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal hub-full"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_line" style="--color-primary:#0265DE;--color-primary-inverse:#fff;--color-primary-alt:#004293;--color-primary-darken-10:#024eab;--color-primary-darken-20:#013779;--color-primary-alpha-25:rgba(2, 101, 222, 0.25);--color-link-primary:#0265DE;--color-link-primary-darken-5:#0259c5;--color-link-primary-darken-10:#024eab;--color-link-primary-darken-20:#013779;--color-link-primary-alpha-50:rgba(2, 101, 222, 0.5);--color-link-primary-alpha-25:rgba(2, 101, 222, 0.25);--color-link-background:rgba(2, 101, 222, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="https://fairing.co/" target="_self"><img alt="Fairing" class="rm-Logo-img rm-Logo-img_lg Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://fairing.canny.io/changelog" target="_self" to="https://fairing.canny.io/changelog">Changelog</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://status.fairing.co" target="_self" to="https://status.fairing.co">Status</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Documentation</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://fairing.canny.io/changelog" rel="noopener" target="_blank" to="https://fairing.canny.io/changelog">Changelog</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://status.fairing.co" rel="noopener" target="_blank" to="https://status.fairing.co">Status</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://docs.fairing.co/page/support" rel="noopener" target="_blank" to="https://docs.fairing.co/page/support">Contact Us</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="https://fairing.co/" target="_self"><img alt="Fairing" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/f01dca6-fairing-logo-h-24px.svg"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-references Header-left-nav-icon10glJKFwewOv"></i>API Reference</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://docs.fairing.co/page/support" target="_self" to="https://docs.fairing.co/page/support">Contact Us</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/docs" target="_self"><i class="icon-guides"></i><span>Documentation</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">The response object</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search ⌘k" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="rm-ReferenceMain rm-Container rm-Container_flex rm-basic-page loading" id="Explorer"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj" id="reference-sidebar"><div class="Main-QuickNav-container1OiLvjSDusO6"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Fairing API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Questions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Questions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The question object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all questions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Responses" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Responses</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The response object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-responses"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all responses</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=fairing" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article" id="content"><header class="headline-container21aRBSn8Bqg6 headline-container_basic1DFntTggitfX" data-raycast-oas="false"><div class="headline-container-grid-itemGdPV-VbhShYs button-containerobFfV0vf6giV"><div class="reference-flyout"><button aria-label="Toggle reference sidebar" class="icon-menu reference-sidebar-mobile-button26mqim6Chewq reference-sidebar-mobile-button_singleCol1Jam1HM1TS00" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj mobile" id="reference-sidebar"><div class="ref-QuickNav-mobile-containerARtvyEDVpRhW"><button aria-keyshortcuts="Control+/ Meta+/" class="QuickNav1q-OoMjiX_Yr QuickNav-button2KzlQbz5Pm2Y">JUMP TO</button></div><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Fairing API</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Introduction</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link" target="_self" href="/reference/authentication"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Authentication</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Questions" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Questions</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/question-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The question object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-questions"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all questions</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 Sidebar-link_parent3OBrzjAJRSfq text-wrap rm-Sidebar-link" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><button aria-expanded="false" aria-label="Show subpages for Responses" class="Sidebar-link-buttonWrapper3hnFHNku8_BJ"><i class="Sidebar-link-expandIcon2yVH6SarI6NW icon-chevron-rightward"></i></button><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Responses</span></span></a><ul class="subpages Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link active" target="_self" href="/reference/the-response-object"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">The response object</span></span></a></li><li class="Sidebar-item23D-2Kd61_k3"><a class="Sidebar-link2Dsha-r-GKh2 childless subpage text-wrap rm-Sidebar-link" target="_self" href="/reference/retrieve-responses"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">List all responses</span></span><span class="Sidebar-method-container2yBYD-KB_IfC"><span class="rm-APIMethod APIMethod APIMethod_fixedWidth APIMethod_get Sidebar-methodfUM3m6FEWm6w" data-testid="http-method">get</span></span></a></li></ul></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=fairing" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav></div></div></div><header id="content-head"><h1>The response object</h1></header></div></header><div class="rm-Markdown markdown-body content-body" data-testid="RDMD"><p>The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the customer.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="properties"></div><div class="heading-text"><div id="section-properties" class="heading-anchor_backwardsCompatibility"></div>Properties</div><a aria-label="Skip link to Properties" class="heading-anchor-icon fa fa-anchor" href="#properties"></a></h3> <div class="rdmd-html"><style> .object-props-list .object-prop__name { font-weight: bold; margin: 0; padding: 8px 0; } .object-prop__name code { font-style: normal; } .object-prop__desc + .object-prop__name { padding-top: 15px; border-top: 1px solid hsl(213, 24%, 91%); } .object-prop__type { color: hsl(216, 13%, 58%); font-size: 14px; font-style: normal; font-weight: normal; } .object-props-list .object-prop__desc, .object-props-list dd.object-prop__desc { margin: 0; margin-inline-start: inherit; padding: 0 0 16px; } </style> <dl class="object-props-list"> <dt class="object-prop__name"> <code>id</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The unique ID of the response. </dd> <dt class="object-prop__name"> <code>available_responses</code> <em class="object-prop__type">array of string</em> </dt> <dd class="object-prop__desc"> The list of response choices that were available to the customer at the time they provided the response. </dd> <dt class="object-prop__name"> <code>clarification_question</code> <em class="object-prop__type">boolean</em> </dt> <dd class="object-prop__desc"> The question for this response was a clarification of a previous question if <code>true</code>. </dd>  <dt class="object-prop__name"> <code>coupon_amount</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The discount amount applied to the order from the coupon. </dd> <dt class="object-prop__name"> <code>coupon_code</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The coupon code used on the order. </dd> <dt class="object-prop__name"> <code>coupon_type</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The coupon type used on the order. For Shopify orders, this will be either <code>fixed</code> or <code>percentage</code>. </dd> <dt class="object-prop__name"> <code>customer_id</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The ID of customer associated with the order for this response. For Shopify orders, this matches the customer's ID in Shopify. </dd> <dt class="object-prop__name"> <code>customer_order_count</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> The total number of orders the customer had at the time they placed the order associated with this response. </dd> <dt class="object-prop__name"> <code>email</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The email address of the customer associated with the order for this response. </dd> <dt class="object-prop__name"> <code>inserted_at</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> ISO 8601 timestamp of the time the response was created. </dd> <dt class="object-prop__name"> <code>landing_page_path</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The first click landing page associated with the order for this response. </dd> <dt class="object-prop__name"> <code>order_currency_code</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The three-letter ISO 4217 currency code of the order. </dd> <dt class="object-prop__name"> <code>order_id</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The ID of the order associated with this response. </dd> <dt class="object-prop__name"> <code>order_number</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The order number of the order associated with this response. </dd> <dt class="object-prop__name"> <code>order_platform</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The platform that provided the order information. For Shopify, this will be <code>shopify</code>. </dd> <dt class="object-prop__name"> <code>order_source</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The source of the order. For Shopify, this will be <code>shopify_checkout</code>. </dd> <dt class="object-prop__name"> <code>order_total</code> <em class="object-prop__type">number</em> </dt> <dd class="object-prop__desc"> The order total in the currency used for payment by the customer. </dd> <dt class="object-prop__name"> <code>order_total_usd</code> <em class="object-prop__type">number</em> </dt> <dd class="object-prop__desc"> The order total in U.S. Dollars. </dd> <dt class="object-prop__name"> <code>original_response</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> If the response was edited, this will be the value of the original response. </dd> <dt class="object-prop__name"> <code>other</code> <em class="object-prop__type">boolean</em> </dt> <dd class="object-prop__desc"> Indicates if the response was free-form text. </dd> <dt class="object-prop__name"> <code>other_response</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> If the response was free-form text, the value of the text. </dd> <dt class="object-prop__name"> <code>question</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The text value of the question associated with this response. </dd> <dt class="object-prop__name"> <code>question_id</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> The ID of the question associated with this response. </dd> <dt class="object-prop__name"> <code>question_type</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The type of the question associated with this response. One of, <code>single_response</code>, <code>multi_response</code>, <code>auto_suggest</code>, <code>date</code>, <code>nps</code> or <code>open_ended</code>. </dd> <dt class="object-prop__name"> <code>referring_question</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> If the question associated with this response is a clarification question, the text value of the question immediately preceeding this one. </dd> <dt class="object-prop__name"> <code>referring_question_id</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> If the question associated with this response is a clarification question, the ID of the question immediately preceeding this one. </dd> <dt class="object-prop__name"> <code>referring_question_response</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> If the question associated with this response is a clarification question, the text value of the response provided to the question immediately preceeding this one. </dd> <dt class="object-prop__name"> <code>referring_question_response_id</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> If the question associated with this response is a clarification question, the ID of the response provided to the question immediately preceeding this one. </dd> <dt class="object-prop__name"> <code>referring_site</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The referring site of the order associated with this response. </dd> <dt class="object-prop__name"> <code>response</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The text value of the response. This will be <code>null</code> if the response was free-form text. </dd> <dt class="object-prop__name"> <code>response_id</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> The ID of the response if it was not free-form text. </dd> <dt class="object-prop__name"> <code>response_position</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> The position of this response in the list of all responses to the associated question at the time it was presented to the customer. If the order of responses for a question is configured to be randomized, this value will not always be the same for the same response. </dd> <dt class="object-prop__name"> <code>response_provided_at</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> ISO 8601 timestamp of the time the response was provided by the customer. </dd> <dt class="object-prop__name"> <code>submit_delta</code> <em class="object-prop__type">integer</em> </dt> <dd class="object-prop__desc"> The time, in milliseconds, bewtween when the question was displayed and the response was submitted. </dd> <dt class="object-prop__name"> <code>updated_at</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> ISO 8601 timestamp of the last time the response was updated. </dd> <dt class="object-prop__name"> <code>utm_campaign</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The UTM campaign of the order associated with this response. </dd> <dt class="object-prop__name"> <code>utm_content</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The UTM content of the order associated with this response. </dd> <dt class="object-prop__name"> <code>utm_medium</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The UTM medium of the order associated with this response. </dd> <dt class="object-prop__name"> <code>utm_source</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The UTM source of the order associated with this response. </dd> <dt class="object-prop__name"> <code>utm_term</code> <em class="object-prop__type">string</em> </dt> <dd class="object-prop__desc"> The UTM term of the order associated with this response. </dd> </dl></div> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="example-response-object"></div><div class="heading-text"><div id="section-example-response-object" class="heading-anchor_backwardsCompatibility"></div>Example response object</div><a aria-label="Skip link to Example response object" class="heading-anchor-icon fa fa-anchor" href="#example-response-object"></a></h3> <div class="CodeTabs CodeTabs_initial theme-light"><div class="CodeTabs-toolbar" role="tablist"><button aria-selected="true" class="CodeTabs_active" role="tab" type="button">JSON</button></div><div class="CodeTabs-inner" role="tabpanel"><pre><button aria-label="Copy Code" class="rdmd-code-copy fa"></button><code class="rdmd-code lang-json theme-light" data-lang="json" name="" tabindex="0">{ "available_responses": [ "Podcast", "Billboard", "Subway Ad" ], "clarification_question": false, "coupon_amount": "10.00", "coupon_code": "SAVE10", "coupon_type": "fixed_amount", "customer_id": "3445695217710", "customer_order_count": 17, "email": "<a href="/cdn-cgi/l/email-protection" class="__cf_email__" data-cfemail="7d1e080e091210180f3d18051c100d1118531e1210">[email protected]</a>", "id": "ENz45Kvbxru0B5X6kDN7Y", "inserted_at": "2022-02-16T17:54:35+00:00", "landing_page_path": "/products/sale", "order_currency_code": "USD", "order_id": "4104320450606", "order_number": "1301", "order_platform": "shopify", "order_source": "shopify_checkout", "order_total": "57.71", "order_total_usd": "57.71", "other": false, "other_response": null, "question": "How did you hear about us?", "question_id": 11, "question_type": "single_response", "referring_question": null, "referring_question_id": null, "referring_question_response": null, "referring_question_response_id": null, "referring_site": "https://google.com", "response": "Podcast", "response_id": 11747, "response_position": 1, "response_provided_at": "2022-02-16T17:54:34Z", "submit_delta": 9428, "updated_at": "2022-02-16T17:54:35+00:00", "utm_campaign": null, "utm_content": null, "utm_medium": null, "utm_source": null, "utm_term": null } </code></pre></div></div></div></article><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li><a href="#properties">Properties</a></li> <li><a href="#example-response-object">Example response object</a></li> </ul></li></ul></nav></section><div class="ModalWrapper" id="response-headers-modal-root"></div><div class="ModalWrapper" id="tutorialmodal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-desktop" id="QuickNav-modal-root"></div><div class="ModalWrapper QuickNav-modal QuickNav-modal-mobile" id="QuickNav-mobile-modal-root"></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script data-cfasync="false" src="/cdn-cgi/scripts/5c5dd728/cloudflare-static/email-decode.min.js"></script><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"5f9c809a8a28490012254350","title":"Welcome to Fairing","slug":"documentation","order":0,"reference":false,"isAPI":false,"version":"5f9c809a8a2849001225434e","project":"5f9c809a8a28490012254347","createdAt":"2020-10-30T21:07:38.539Z","__v":0,"pages":[{"_id":"5fa02ab8e5f0dd002c63717d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction","type":"basic","slug":"welcome","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T15:50:16.065Z","category":"5f9c809a8a28490012254350","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa158c19544d0002e4becac","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"FAQs - Troubleshoot","type":"basic","slug":"faqs","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-03T13:18:57.860Z","category":"5f9c809a8a28490012254350","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6585b820f9e20500559914f3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Debugger","icon":"","type":"basic","slug":"debugger","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa158c19544d0002e4becac","category":"5f9c809a8a28490012254350","createdAt":"2023-12-22T16:24:00.744Z","isBodyEmpty":false,"children":[]}]},{"_id":"64cd2daa75e28e00461d7f0e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Accessibility Statement","icon":"","type":"basic","slug":"accessibility-statement","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"accessibility-statement-for-fairing","category":"5f9c809a8a28490012254350","createdAt":"2023-08-04T16:56:10.726Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"614249d5c18e5500792e9494","title":"Quick Start","slug":"quick-start","order":1,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-09-15T19:30:29.165Z","__v":0,"pages":[{"_id":"614249daa0b594022a345429","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify","type":"basic","slug":"shopify","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-15T19:30:34.678Z","category":"614249d5c18e5500792e9494","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"651344e7124371007a5098c0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify Checkout Extensibility","icon":"","type":"basic","slug":"shopify-checkout-extensions","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"614249daa0b594022a345429","category":"614249d5c18e5500792e9494","createdAt":"2023-09-26T20:53:59.760Z","isBodyEmpty":false,"children":[]},{"_id":"64c958dd06c90b004b2a3217","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shopify Point-of-Sale (POS)","icon":"","type":"basic","slug":"point-of-sale-shopify","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-08-01T19:11:25.072Z","parentDoc":"614249daa0b594022a345429","isBodyEmpty":false,"children":[]},{"_id":"614249019167d10072098829","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Look And Feel","type":"basic","slug":"look-and-feel","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-15T19:26:57.635Z","category":"614249d5c18e5500792e9494","parentDoc":"614249daa0b594022a345429","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"619678c0bb921d003013b939","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Question Stream Location","type":"basic","slug":"question-stream-custom-location","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-stream-location","createdAt":"2021-11-18T16:01:04.298Z","parentDoc":"614249019167d10072098829","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]},{"_id":"621502e49500ff05050588c6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Full-Page Takeover (Advanced)","type":"basic","slug":"full-page-takeover-advanced","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-22T15:36:04.919Z","parentDoc":"614249019167d10072098829","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"6196bfa2bffcef002cc1fc86","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Headless Integration","type":"basic","slug":"headless-integration","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"headless-integration1","parentDoc":"614249daa0b594022a345429","createdAt":"2021-11-18T21:03:30.397Z","category":"614249d5c18e5500792e9494","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"614249df9abefc001408fa3c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Custom Snippet","type":"basic","slug":"sdk","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"sdk-1","createdAt":"2021-09-15T19:30:39.555Z","category":"614249d5c18e5500792e9494","parentDoc":null,"deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[{"_id":"62ab9d68bc151f001ae9fdec","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Events","type":"basic","slug":"events","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-06-16T21:15:20.209Z","category":"614249d5c18e5500792e9494","parentDoc":"614249df9abefc001408fa3c","icon":"","isBodyEmpty":false,"children":[]},{"_id":"664680d00c575500697182a1","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Sample Question Stream HTML","icon":"","type":"basic","slug":"sample-question-stream-html","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"614249df9abefc001408fa3c","category":"614249d5c18e5500792e9494","createdAt":"2024-05-16T21:55:28.427Z","isBodyEmpty":false,"children":[]}]},{"_id":"64640cdd00e6a8000a6d33f0","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Salesforce Commerce Cloud","icon":"","type":"basic","slug":"salesforce-commerce-cloud","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-05-16T23:08:13.908Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64b01721068aa7155a6a994b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"WooCommerce","icon":"","type":"basic","slug":"woocommerce","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"614249d5c18e5500792e9494","createdAt":"2023-07-13T15:24:17.812Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6234ecb0350c8c022e134a32","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"API","type":"link","slug":"api-1","order":10,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://docs.fairing.co/docs/api","link_external":true,"previousSlug":"","createdAt":"2022-03-18T20:33:52.981Z","category":"614249d5c18e5500792e9494","parentDoc":null,"icon":"","isBodyEmpty":true,"children":[]},{"_id":"636dc7cd2333a30030222373","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Question Bank","icon":"","type":"basic","slug":"question-bank","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-bank-1","createdAt":"2022-11-11T03:55:57.233Z","category":"614249d5c18e5500792e9494","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"611d15894b2b1000100bb85c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Example Questions","type":"basic","slug":"question-bank-archive","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-bank","createdAt":"2021-08-18T14:13:29.681Z","parentDoc":"636dc7cd2333a30030222373","category":"614249d5c18e5500792e9494","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"632c778475842a0010df2637","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"User Accounts","icon":"","type":"basic","slug":"user-accounts","order":12,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-22T14:56:04.954Z","category":"614249d5c18e5500792e9494","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"61424894389be2012719f36f","title":"Question Stream™","slug":"question-stream","order":2,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-09-15T19:25:08.469Z","__v":0,"pages":[{"_id":"61424a308b07ed004ee7a3dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Functionality","type":"basic","slug":"question-stream-functionality","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"question-stream-functionality1","parentDoc":null,"createdAt":"2021-09-15T19:32:00.982Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","mdx":{},"isBodyEmpty":false,"children":[{"_id":"6196c163da1929000ffb21f7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Previewing Your Survey","type":"basic","slug":"previewing-your-survey","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"previewing-your-survey1","parentDoc":"61424a308b07ed004ee7a3dd","createdAt":"2021-11-18T21:10:59.241Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61424aa70ed20100789e105e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Creating & Editing Questions","type":"basic","slug":"creating-and-editing-questions","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"creating-editing-questions1","parentDoc":null,"createdAt":"2021-09-15T19:33:59.347Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"61439ef77659640012554f82","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Clarification (2-step)","type":"basic","slug":"response-clarification","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-clarification-2-step1111","createdAt":"2021-09-16T19:45:59.164Z","category":"61424894389be2012719f36f","parentDoc":"61424aa70ed20100789e105e","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"64666992da244900275c8362","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Auto Advance","icon":"","type":"basic","slug":"auto-advance","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","createdAt":"2023-05-18T18:08:18.918Z","isBodyEmpty":false,"children":[]},{"_id":"6155d4fd197c7900466959f6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Randomize Response Options","type":"basic","slug":"randomization-of-responses","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-30T15:17:17.034Z","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"646e6e9e25ce3c000ae126d3","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Question Targeting Rules","icon":"","type":"basic","slug":"question-targeting-rules","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"61424aa70ed20100789e105e","category":"61424894389be2012719f36f","createdAt":"2023-05-24T20:07:58.890Z","mdx":{},"isBodyEmpty":false,"children":[{"_id":"647621b141101e000c2e5ff0","api":{"method":"get","url":"","auth":"required","params":[]},"title":"New vs Returning","icon":"","type":"basic","slug":"new-vs-returning","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:17:53.203Z","isBodyEmpty":false,"children":[]},{"_id":"647621c1c7d148001f6e6617","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Geographic Location","icon":"","type":"basic","slug":"customer-location","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:18:09.642Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"647621cff7a283000c25a09b","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Products Purchased","icon":"","type":"basic","slug":"products-purchased","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T16:18:23.705Z","isBodyEmpty":false,"children":[]},{"_id":"64763f7f20bd4f004f9c1504","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Question Frequency","icon":"","type":"basic","slug":"question-frequency","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"frequency","parentDoc":"646e6e9e25ce3c000ae126d3","category":"61424894389be2012719f36f","createdAt":"2023-05-30T18:25:03.145Z","mdx":{},"isBodyEmpty":false,"children":[]}]}]},{"_id":"61b27a24e65e5c002cd8e0d2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Custom Success Message","type":"basic","slug":"success-message","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-12-09T21:50:28.156Z","parentDoc":null,"category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6196b30fe3978e0041be250d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Analytics","type":"basic","slug":"analytics","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"analytics1","createdAt":"2021-11-18T20:09:51.707Z","category":"61424894389be2012719f36f","parentDoc":null,"icon":"","mdx":{},"isBodyEmpty":false,"children":[{"_id":"64c147526fcf1c002aee7f56","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Time Series Analytics","icon":"","type":"basic","slug":"time-series-analytics","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-07-26T16:18:26.321Z","isBodyEmpty":false,"children":[]},{"_id":"647613d655e116000a105112","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Comparison Analytics","icon":"","type":"basic","slug":"comparison-analytics","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-05-30T15:18:46.755Z","isBodyEmpty":false,"children":[]},{"_id":"64cbc87fd304950af8f721dd","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"NPS Analytics","icon":"","type":"basic","slug":"nps-reporting","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2023-08-03T15:32:15.654Z","isBodyEmpty":false,"children":[]},{"_id":"6196b3a329345900486ebc5e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Clarification Analytics","type":"basic","slug":"response-clarification-analytics","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-clarification-analytics1","parentDoc":"6196b30fe3978e0041be250d","createdAt":"2021-11-18T20:12:19.190Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"632865b852afa700803cf79d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Extrapolated Count & Revenue","icon":"","type":"basic","slug":"extrapolation","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"extrapolation-of-response-data","createdAt":"2022-09-19T12:51:04.554Z","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"664e4da247da2f005b54f3da","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Last Click Report","icon":"","type":"basic","slug":"insights","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2024-05-22T19:55:14.385Z","isBodyEmpty":false,"children":[]},{"_id":"664e5551442cd20061160f7f","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Discount Code Report","icon":"","type":"basic","slug":"discount-code-report","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6196b30fe3978e0041be250d","category":"61424894389be2012719f36f","createdAt":"2024-05-22T20:28:01.769Z","isBodyEmpty":false,"children":[]}]},{"_id":"61eabb9b2213ae03b3e7d6c7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Responses","type":"basic","slug":"responses-page-1","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-21T13:56:43.190Z","category":"61424894389be2012719f36f","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"638e5ac82fb03f004007f5c0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Response Recategorization","icon":"","type":"basic","slug":"response-recategorization","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"response-reclassification","createdAt":"2022-12-05T20:55:36.054Z","parentDoc":"61eabb9b2213ae03b3e7d6c7","category":"61424894389be2012719f36f","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"61424c7159f96d000f90c21b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Exporting Your Data","type":"basic","slug":"exporting-your-data","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"exporting-your-data1","createdAt":"2021-09-15T19:41:37.766Z","category":"61424894389be2012719f36f","parentDoc":"61eabb9b2213ae03b3e7d6c7","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"664e1b003ecc59005609bd22","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Lifetime Value Analytics","icon":"","type":"basic","slug":"lifetime-value-analytics","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"lifetime-value-reports","category":"61424894389be2012719f36f","createdAt":"2024-05-22T16:19:12.172Z","parentDoc":null,"mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"64cbc7c4ab991c0b929b790b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Customer View","icon":"","type":"basic","slug":"customer-view","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2023-08-03T15:29:08.653Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"64c15dddda74d20049ad1a3b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Live Feed","icon":"","type":"basic","slug":"live-feed","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2023-07-26T17:54:37.581Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"65b2c5b78dac5c007319bfbb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Language Translations","icon":"","type":"basic","slug":"language-translations","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"61424894389be2012719f36f","createdAt":"2024-01-25T20:33:59.387Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5fa0326f5c4e7600479d4a31","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Integrations Catalog","type":"basic","slug":"integrations-catalog","order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T16:23:11.592Z","category":"61424894389be2012719f36f","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6000b601744332007d7893a9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Alloy","type":"basic","slug":"alloy","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-01-14T21:22:09.794Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"609a883c437af7005a11d7d8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Daasity","type":"basic","slug":"daasity","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","createdAt":"2021-05-11T13:35:56.866Z","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"62feb9cc4bfc2400210f125e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Daton by Saras Analytics","icon":"","type":"basic","slug":"daton","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"saras-analytics","createdAt":"2022-08-18T22:14:36.673Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"659714b2a1dfab0016cd1a22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Disco","icon":"","type":"basic","slug":"disco","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2024-01-04T20:27:30.932Z","isBodyEmpty":true,"children":[]},{"_id":"611fa975620e55005b08f922","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Elevar","type":"basic","slug":"elevar","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-20T13:09:09.591Z","category":"61424894389be2012719f36f","parentDoc":"5fa0326f5c4e7600479d4a31","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"638e4d71da5785006ee8f9ba","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Funnel","icon":"","type":"basic","slug":"funnel","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"funnelio","createdAt":"2022-12-05T19:58:41.748Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"5fa05acc1cb0e00035626cb9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Analytics (GA4)","type":"basic","slug":"google-analytics-4","order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"google-analytics","createdAt":"2020-11-02T19:15:24.406Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63ca8e1a1df82c00823d596c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Sheets Extension","icon":"","type":"basic","slug":"google-sheets","order":9,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-01-20T12:50:34.734Z","isBodyEmpty":false,"children":[]},{"_id":"611fa9986bdb56024c874200","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Google Tag Manager","type":"basic","slug":"google-tag-manager","order":10,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-20T13:09:44.800Z","category":"61424894389be2012719f36f","parentDoc":"5fa0326f5c4e7600479d4a31","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"64f72e48465231102c6f60c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Klar","icon":"","type":"basic","slug":"klar","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-09-05T13:34:00.309Z","isBodyEmpty":false,"children":[]},{"_id":"5fa05ac28fb1ef0018c31382","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Klaviyo","type":"basic","slug":"klaviyo","order":12,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:14.518Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"638e4d60a994d1002ee636e9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Measured","icon":"","type":"basic","slug":"measured","order":13,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-12-05T19:58:24.137Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"62b35661a3f3f8005055c73d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Peel","type":"basic","slug":"peel","order":15,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-06-22T17:50:25.051Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"655d1ed8259d1b001273d6c4","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Podscribe","icon":"","type":"basic","slug":"podscribe","order":16,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-11-21T21:19:20.897Z","isBodyEmpty":false,"children":[]},{"_id":"5fa05ae0e29f6b00434b4605","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Recharge","type":"basic","slug":"recharge","order":17,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:44.482Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa05ae97145480052ffd8b7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Rockerbox","type":"basic","slug":"rockerbox","order":18,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T19:15:53.537Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"640fced8946f1800291037a7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Segment","icon":"","type":"basic","slug":"segment","order":19,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-03-14T01:33:12.845Z","isBodyEmpty":false,"children":[]},{"_id":"5fa07879f5bb2e006590128c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Shopify Flow","type":"basic","slug":"shopify-flow","order":20,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-02T21:22:01.374Z","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63f8d03a5e45e0007318e91f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Source Medium","icon":"","type":"basic","slug":"source-medium","order":21,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-24T14:56:58.872Z","isBodyEmpty":false,"children":[]},{"_id":"63dd397aad9f8f0050c43567","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"TikTok","icon":"","type":"basic","slug":"tiktok","order":22,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-03T16:42:34.478Z","isBodyEmpty":false,"children":[]},{"_id":"61d72d38a7cda302ae333ab6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Triple Whale","type":"basic","slug":"triple-whale","order":23,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"triple-whale1","parentDoc":"5fa0326f5c4e7600479d4a31","createdAt":"2022-01-06T17:56:08.597Z","category":"61424894389be2012719f36f","icon":"","isBodyEmpty":false,"children":[]},{"_id":"651c38fc8982560049e6112d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Yotpo SMS & Email","icon":"","type":"basic","slug":"yotpo","order":24,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-10-03T15:53:32.796Z","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"63ebfd8a178d63054682dbc8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Wonderment","icon":"","type":"basic","slug":"wonderment","order":25,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa0326f5c4e7600479d4a31","category":"61424894389be2012719f36f","createdAt":"2023-02-14T21:30:50.043Z","isBodyEmpty":true,"children":[]}]},{"_id":"63506c7d79803a001e04dd91","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Data Sync","icon":"","type":"basic","slug":"data-sync","order":11,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:30:37.737Z","category":"61424894389be2012719f36f","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"63506deead645100602f19ff","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"AWS S3","icon":"","type":"basic","slug":"aws-s3","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:36:46.523Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e057786260090ed16b9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"BigQuery","icon":"","type":"basic","slug":"bigquery","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:37:09.808Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e3ca0550d0561eea1ad","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Google Cloud Storage (GCS)","icon":"","type":"basic","slug":"google-cloud-storage-gcs","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:04.706Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e450df39b00338b3619","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"MySQL","icon":"","type":"basic","slug":"mysql","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:13.786Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e4fdbb3b500866d7286","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Postgres","icon":"","type":"basic","slug":"postgres","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:23.825Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e67e0dc4b003aba8d85","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Redshift","icon":"","type":"basic","slug":"redshift","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:38:47.751Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"63506e852bbca6009df72f70","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Snowflake","icon":"","type":"basic","slug":"snowflake","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-10-19T21:39:17.347Z","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","isBodyEmpty":false,"children":[]},{"_id":"6617f40f3b1d3200100fb639","api":{"method":"get","url":"","auth":"required","params":[]},"title":"Data Dictionary","icon":"","type":"basic","slug":"data-dictionary","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"63506c7d79803a001e04dd91","category":"61424894389be2012719f36f","createdAt":"2024-04-11T14:30:39.022Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"5fa0318c300535004df4438b","title":"Resources","slug":"resources","order":4,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2020-11-02T16:19:24.588Z","__v":0,"pages":[{"_id":"5fad84a86ba1e80019c59fa7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Under The Hood","type":"basic","slug":"how-does-fairing-work","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"how-does-enquirelabs-work","createdAt":"2020-11-12T18:53:28.768Z","parentDoc":null,"category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa438c4b51f94001878b15b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Optimizing Your Survey","type":"basic","slug":"optimizing-your-survey","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:39:16.823Z","category":"5fa0318c300535004df4438b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"5fa43ab094dab80011856ff8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"How Load Time Affects Response Rates","type":"basic","slug":"how-load-time-affects-your-survey-completion-rate","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:47:28.168Z","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5fa43ad048ac140036657b51","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"How Many Options is Optimal For Survey Completion?","type":"basic","slug":"how-many-options-is-optimal-for-survey-completion","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-05T17:48:00.163Z","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"66e08c26f21ab700611c0c05","api":{"method":"get","url":"","auth":"required","params":[]},"title":"How Question Rank Affects Response Rates","icon":"","type":"basic","slug":"how-question-rank-affects-response-rate","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5fa438c4b51f94001878b15b","category":"5fa0318c300535004df4438b","createdAt":"2024-09-10T18:12:54.375Z","mdx":{},"isBodyEmpty":false,"children":[]}]}]},{"_id":"619e689de5d14a03042fb4e5","title":"Shopify Flow","slug":"shopify-flow","order":5,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2021-11-24T16:30:21.173Z","__v":0,"pages":[{"_id":"63a0904aa93c95004adbea37","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Shopify Flow Examples","icon":"","type":"basic","slug":"shopify-flow-examples","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"619e689de5d14a03042fb4e5","createdAt":"2022-12-19T16:24:42.034Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"619e68a6e65711004f6619a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Google Sheets","type":"basic","slug":"add-responses-to-google-sheets-using-shopify-flow","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"google-sheets","createdAt":"2021-11-24T16:30:30.203Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4f0b9f856270033391db3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Slack","type":"basic","slug":"send-responses-to-slack-using-shopify-flow","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"slack","createdAt":"2021-11-29T15:24:41.306Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4fa3d0fc9bb0029d98c9d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Tag Customers & Orders","type":"basic","slug":"tag-customers-and-orders-with-response-data","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"tag-customers-orders","createdAt":"2021-11-29T16:05:17.015Z","category":"619e689de5d14a03042fb4e5","parentDoc":"63a0904aa93c95004adbea37","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"61a4e7bde1943f002e59d318","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"HTTP Request","type":"basic","slug":"exporting-to-database-shopify-flow","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-11-29T14:46:21.512Z","category":"619e689de5d14a03042fb4e5","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[{"_id":"61a4e7d4f45cd0005bdc333e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Stitchdata","type":"basic","slug":"export-using-shopify-flow-and-stitchdata","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"export-using-shopify-flow-legacy","parentDoc":"61a4e7bde1943f002e59d318","createdAt":"2021-11-29T14:46:44.981Z","category":"619e689de5d14a03042fb4e5","icon":"","isBodyEmpty":false,"children":[]},{"_id":"61a4ea5616e1e3000f8fe96a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Fivetran","type":"basic","slug":"export-using-shopify-flow-and-fivetran","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"export-using-shopify-flow-and-fivetran1-1","parentDoc":"61a4e7bde1943f002e59d318","createdAt":"2021-11-29T14:57:26.593Z","category":"619e689de5d14a03042fb4e5","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5fa158f705478c0012bd39d3","title":"Tutorials","slug":"tutorials","order":6,"reference":false,"isAPI":false,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2020-11-03T13:19:51.849Z","__v":0,"pages":[{"_id":"5faf014675d6da001e083e04","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Attribution Surveys","type":"basic","slug":"attribution","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2020-11-13T21:57:26.857Z","category":"5fa158f705478c0012bd39d3","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"654d00d3d2edb90949ef7ef1","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Landing Page (Alpha)","icon":"","type":"basic","slug":"landing-page-alpha","order":8,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:54:59.195Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"654d00f76652a31f10c74c21","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Landing Page (HTML)","icon":"","type":"basic","slug":"landing-page-html","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:55:35.283Z","isBodyEmpty":false,"children":[]},{"_id":"654d01017a569f005ed22f06","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Email Template (HTML)","icon":"","type":"basic","slug":"email-template-html","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T15:55:45.730Z","isBodyEmpty":false,"children":[]},{"_id":"654d10f0b14ec7004c53b911","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Klaviyo Flow","icon":"","type":"basic","slug":"klaviyo-flow","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"654d00d3d2edb90949ef7ef1","category":"5fa158f705478c0012bd39d3","createdAt":"2023-11-09T17:03:44.819Z","isBodyEmpty":false,"children":[]}]}]}],"refs":[{"_id":"6220bbe23ea59300135fe5d2","title":"Fairing API","slug":"enquirelabs-api","order":8,"reference":true,"project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2022-03-03T13:00:18.568Z","__v":0,"pages":[{"_id":"622ccbeb335e33008fa1124c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Introduction","type":"basic","slug":"api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-2","createdAt":"2022-03-12T16:35:55.207Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6220bdc1e6275701a32ceb15","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Authentication","type":"basic","slug":"authentication","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"apiauthentication","createdAt":"2022-03-03T13:08:17.849Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"622ccc4c4c081f0037ad7d04","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Questions","type":"basic","slug":"questions","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:37:32.815Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"622ccc5ba8ceb9004545bf55","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"The question object","type":"basic","slug":"question-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:37:47.860Z","parentDoc":"622ccc4c4c081f0037ad7d04","category":"6220bbe23ea59300135fe5d2","icon":"","isBodyEmpty":false,"children":[]},{"_id":"622ccd26cc60c9002b8484c8","api":{"method":"get","url":"/questions","auth":"required","results":{"codes":[{"name":"","code":"{\n \"data\": [\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"once\",\n \"id\": 1818,\n \"inserted_at\": \"2021-07-06T14:49:37+00:00\",\n \"other_placeholder\": \"Other\",\n \"prompt\": \"One more thing: How did you hear about us?\",\n \"published_at\": \"2021-09-22T18:57:15+00:00\",\n \"randomize_responses\": false,\n \"responses\": [\n {\n \"clarification_question\": {\n \"allow_other\": true,\n \"id\": 1873,\n \"other_placeholder\": \"Other\",\n \"prompt\": \"Who told you?\",\n \"randomize_responses\": true,\n \"responses\": [\n {\n \"id\": 11834,\n \"value\": \"A friend\"\n },\n {\n \"id\": 11835,\n \"value\": \"A family member\"\n }\n ],\n \"type\": \"single_response\"\n },\n \"id\": 11379,\n \"value\": \"From a friend or family member (has clarification)\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11381,\n \"value\": \"Online Article\"\n },\n {\n \"clarification_question\": {\n \"allow_other\": true,\n \"id\": 2137,\n \"other_placeholder\": null,\n \"prompt\": \"Who is the influencer? \",\n \"randomize_responses\": true,\n \"responses\": [],\n \"type\": \"open_ended\"\n },\n \"id\": 11410,\n \"value\": \"Was it an influencer? \"\n }\n ],\n \"submit_text\": \"Submit\",\n \"type\": \"single_response\",\n \"updated_at\": \"2022-01-07T14:58:01+00:00\"\n },\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"always\",\n \"id\": 33,\n \"inserted_at\": \"2021-05-07T19:14:25+00:00\",\n \"other_placeholder\": null,\n \"prompt\": \"What kind of car do you drive?\",\n \"published_at\": \"2022-02-15T15:39:52+00:00\",\n \"randomize_responses\": true,\n \"responses\": [],\n \"submit_text\": \"Submit\",\n \"type\": \"open_ended\",\n \"updated_at\": \"2022-02-15T15:39:52+00:00\"\n },\n {\n \"allow_other\": true,\n \"customer_type\": \"everyone\",\n \"frequency_type\": \"always\",\n \"id\": 12,\n \"inserted_at\": \"2021-04-20T19:31:04+00:00\",\n \"other_placeholder\": \"Other\",\n \"prompt\": \"Do you own or pay for any of the following?\",\n \"published_at\": \"2022-02-15T15:39:53+00:00\",\n \"randomize_responses\": true,\n \"responses\": [\n {\n \"clarification_question\": null,\n \"id\": 11763,\n \"value\": \"Gym Membership\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11784,\n \"value\": \"Peloton\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11785,\n \"value\": \"Mirror\"\n },\n {\n \"clarification_question\": null,\n \"id\": 11787,\n \"value\": \"Tonal\"\n }\n ],\n \"submit_text\": \"Submit\",\n \"type\": \"multi_response\",\n \"updated_at\": \"2022-02-15T15:39:53+00:00\"\n }\n ]\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"apiSetting":"6220bbe23ea59300135fe5d0","examples":{"codes":[{"code":"","language":"curl"}]}},"title":"List all questions","type":"endpoint","slug":"retrieve-questions","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-12T16:41:10.343Z","parentDoc":"622ccc4c4c081f0037ad7d04","category":"6220bbe23ea59300135fe5d2","isBodyEmpty":false,"children":[]}]},{"_id":"6220bf448be6c7003d11b594","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Responses","type":"basic","slug":"responses","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-03-03T13:14:44.089Z","category":"6220bbe23ea59300135fe5d2","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"62349c75be46080018e93060","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"The response object","type":"basic","slug":"the-response-object","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"the-response-object-1","createdAt":"2022-03-18T14:51:33.588Z","category":"6220bbe23ea59300135fe5d2","parentDoc":"6220bf448be6c7003d11b594","icon":"","mdx":{},"isBodyEmpty":false,"children":[]},{"_id":"6220bf8f7419610131261d4b","api":{"method":"get","url":"/responses","auth":"required","results":{"codes":[{"name":"Success","code":"{\n \"data\":[\n {\n \"available_responses\":null,\n \"clarification_question\":false,\n \"coupon_amount\":null,\n \"coupon_code\":null,\n \"coupon_type\":null,\n \"customer_id\":\"3445695217710\",\n \"customer_order_count\":17,\n \"email\":\"user@example.com\",\n \"id\":\"ENz45Kvbxru0B5X6kDN7Y\",\n \"inserted_at\":\"2022-02-16T17:54:35+00:00\",\n \"landing_page_path\":null,\n \"order_currency_code\":\"USD\",\n \"order_id\":\"4104320450606\",\n \"order_number\":\"1301\",\n \"order_platform\":\"shopify\",\n \"order_source\":\"shopify_checkout\",\n \"order_total\":\"57.71\",\n \"order_total_usd\":\"57.71\",\n \"other\":false,\n \"other_response\":null,\n \"question\":\"Who is your favorite co-founder?\",\n \"question_id\":11,\n \"question_type\":\"single_response\",\n \"referring_question\":null,\n \"referring_question_id\":null,\n \"referring_question_response\":null,\n \"referring_question_response_id\":null,\n \"referring_site\":\"null\",\n \"response\":\"Somebody Else\",\n \"response_id\":11747,\n \"response_position\":1,\n \"response_provided_at\":\"2022-02-16T17:54:34Z\",\n \"submit_delta\":9428,\n \"updated_at\":\"2022-02-16T17:54:35+00:00\",\n \"utm_campaign\":null,\n \"utm_content\":null,\n \"utm_medium\":null,\n \"utm_source\":null,\n \"utm_term\":null\n },\n {\n \"available_responses\":null,\n \"clarification_question\":true,\n \"coupon_amount\":null,\n \"coupon_code\":null,\n \"coupon_type\":null,\n \"customer_id\":\"3446081224750\",\n \"customer_order_count\":10,\n \"email\":\"user_one@example.com\",\n \"id\":\"pk9ZDChjMNueWHZqHEF5Z\",\n \"inserted_at\":\"2021-07-09T18:35:57+00:00\",\n \"landing_page_path\":null,\n \"order_currency_code\":null,\n \"order_id\":\"3821070549038\",\n \"order_number\":\"1260\",\n \"order_platform\":null,\n \"order_source\":null,\n \"order_total\":null,\n \"order_total_usd\":null,\n \"other\":false,\n \"other_response\":null,\n \"question\":\"Which one?\",\n \"question_id\":2138,\n \"question_type\":\"single_response\",\n \"referring_question\":\"How did you hear about us?\",\n \"referring_question_id\":9,\n \"referring_question_response\":\"Online Ad\",\n \"referring_question_response_id\":11733,\n \"referring_site\":null,\n \"response\":\"Facebook\",\n \"response_id\":11734,\n \"response_position\":1,\n \"response_provided_at\":\"2021-07-09T18:35:57Z\",\n \"submit_delta\":1884,\n \"updated_at\":\"2021-07-09T18:35:57+00:00\",\n \"utm_campaign\":null,\n \"utm_content\":null,\n \"utm_medium\":null,\n \"utm_source\":null,\n \"utm_term\":null\n }\n ],\n \"next\":\"https://app.enquirelabs.com/api/responses?after=pk9ZDChjMNueWHZqHEF5Z\",\n \"prev\":\"https://app.enquirelabs.com/api/responses?before=ENz45Kvbxru0B5X6kDN7Y\"\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Not found\",\n \"status\": 404\n}","language":"json","status":404},{"code":"{\n \"message\": \"Unauthorized\",\n \"status\": 401\n}","language":"json","status":401}]},"params":[{"name":"before","type":"string","enumValues":"","default":"","desc":"Response ID, used as a cursor in pagination. Use this to fetch the page **before** the response.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7822"},{"name":"after","type":"string","enumValues":"","default":"","desc":"Response ID, used as a cursor in pagination. Use this to fetch the page **after** the response.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7821"},{"name":"limit","type":"int","enumValues":"","default":"2","desc":"The number of responses to fetch per request. The maximum is 100.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac7820"},{"name":"since","type":"timestamp","enumValues":"","default":"","desc":"Use this ISO8601 formatted timestamp to fetch responses that are newer than the supplied value.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac781f"},{"name":"until","type":"timestamp","enumValues":"","default":"","desc":"Use this ISO8601 formatted timestamp to fetch responses that are older than the supplied value.","required":false,"in":"query","ref":"","_id":"6220c7d094c85e03d0ac781e"},{"name":"question_id","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"query","ref":"","_id":"62349a13955e4f0196e7ade4"}],"apiSetting":"6220bbe23ea59300135fe5d0","examples":{"codes":[{"code":"","language":"curl"}]}},"title":"List all responses","type":"endpoint","slug":"retrieve-responses","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-all-responses","createdAt":"2022-03-03T13:15:59.757Z","parentDoc":"6220bf448be6c7003d11b594","category":"6220bbe23ea59300135fe5d2","isBodyEmpty":false,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"NDU2MjZlM2U2OWJiZGVlZmE4ODkwYjBmZjU0YTVhMTE0ZTM2ZDk1NTIwYWFlNzk3OWZmMjk5NjIxNDUxOThhY3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzQ3KSwodmVyc2lvbjpub25lLHZlcnNpb246NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzRlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5f9c809a8a28490012254347","name":"Fairing","subdomain":"fairing","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"fairing"},"version":"1.0"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"next":{"description":"","pages":[]},"algolia":{"recordCount":3,"publishPending":false,"translationFailure":false,"updatedAt":"2024-12-16T17:27:11.195Z"},"title":"The response object","icon":"","updates":[],"type":"basic","slug":"the-response-object","excerpt":"","body":"The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the customer.\n\n### Properties\n\n[block:html]\n{\n \"html\": \"<style>\\n .object-props-list .object-prop__name {\\n font-weight: bold;\\n margin: 0;\\n padding: 8px 0;\\n }\\n \\n .object-prop__name code {\\n font-style: normal;\\n }\\n\\n .object-prop__desc + .object-prop__name {\\n padding-top: 15px;\\n border-top: 1px solid hsl(213, 24%, 91%);\\n }\\n\\n .object-prop__type {\\n color: hsl(216, 13%, 58%);\\n font-size: 14px;\\n font-style: normal;\\n font-weight: normal;\\n }\\n\\n .object-props-list .object-prop__desc,\\n .object-props-list dd.object-prop__desc {\\n margin: 0;\\n margin-inline-start: inherit;\\n padding: 0 0 16px;\\n }\\n</style>\\n\\n\\n<dl class=\\\"object-props-list\\\">\\n <dt class=\\\"object-prop__name\\\">\\n <code>id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The unique ID of the response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>available_responses</code> <em class=\\\"object-prop__type\\\">array of string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The list of response choices that were available to the customer at the time they provided the response.\\n </dd> \\n <dt class=\\\"object-prop__name\\\">\\n <code>clarification_question</code> <em class=\\\"object-prop__type\\\">boolean</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The question for this response was a clarification of a previous question if <code>true</code>.\\n </dd>\\n\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_amount</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The discount amount applied to the order from the coupon.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_code</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The coupon code used on the order.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_type</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The coupon type used on the order. For Shopify orders, this will be either <code>fixed</code> or <code>percentage</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>customer_id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of customer associated with the order for this response. For Shopify orders, this matches the customer's ID in Shopify.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>customer_order_count</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The total number of orders the customer had at the time they placed the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>email</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The email address of the customer associated with the order for this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>inserted_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the time the response was created.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>landing_page_path</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The first click landing page associated with the order for this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_currency_code</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The three-letter ISO 4217 currency code of the order.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_number</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order number of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_platform</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The platform that provided the order information. For Shopify, this will be <code>shopify</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_source</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The source of the order. For Shopify, this will be <code>shopify_checkout</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_total</code> <em class=\\\"object-prop__type\\\">number</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order total in the currency used for payment by the customer.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_total_usd</code> <em class=\\\"object-prop__type\\\">number</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order total in U.S. Dollars.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>original_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the response was edited, this will be the value of the original response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>other</code> <em class=\\\"object-prop__type\\\">boolean</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n Indicates if the response was free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>other_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the response was free-form text, the value of the text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The text value of the question associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the question associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question_type</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The type of the question associated with this response. One of, <code>single_response</code>, <code>multi_response</code>, <code>auto_suggest</code>, <code>date</code>, <code>nps</code> or <code>open_ended</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the text value of the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the ID of the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the text value of the response provided to the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_response_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the ID of the response provided to the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_site</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The referring site of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The text value of the response. This will be <code>null</code> if the response was free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the response if it was not free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_position</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The position of this response in the list of all responses to the associated question at the time it was presented to the customer. If the order of responses for a question is configured to be randomized, this value will not always be the same for the same response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_provided_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the time the response was provided by the customer.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>submit_delta</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The time, in milliseconds, bewtween when the question was displayed and the response was submitted.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>updated_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the last time the response was updated.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_campaign</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM campaign of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_content</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM content of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_medium</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM medium of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_source</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM source of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_term</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM term of the order associated with this response.\\n </dd>\\n</dl>\"\n}\n[/block]\n\n\n### Example response object\n\n```json\n{\n \"available_responses\": [\n \"Podcast\",\n \"Billboard\",\n \"Subway Ad\"\n ],\n \"clarification_question\": false,\n \"coupon_amount\": \"10.00\",\n \"coupon_code\": \"SAVE10\",\n \"coupon_type\": \"fixed_amount\",\n \"customer_id\": \"3445695217710\",\n \"customer_order_count\": 17,\n \"email\": \"customer@example.com\",\n \"id\": \"ENz45Kvbxru0B5X6kDN7Y\",\n \"inserted_at\": \"2022-02-16T17:54:35+00:00\",\n \"landing_page_path\": \"/products/sale\",\n \"order_currency_code\": \"USD\",\n \"order_id\": \"4104320450606\",\n \"order_number\": \"1301\",\n \"order_platform\": \"shopify\",\n \"order_source\": \"shopify_checkout\",\n \"order_total\": \"57.71\",\n \"order_total_usd\": \"57.71\",\n \"other\": false,\n \"other_response\": null,\n \"question\": \"How did you hear about us?\",\n \"question_id\": 11,\n \"question_type\": \"single_response\",\n \"referring_question\": null,\n \"referring_question_id\": null,\n \"referring_question_response\": null,\n \"referring_question_response_id\": null,\n \"referring_site\": \"https://google.com\",\n \"response\": \"Podcast\",\n \"response_id\": 11747,\n \"response_position\": 1,\n \"response_provided_at\": \"2022-02-16T17:54:34Z\",\n \"submit_delta\": 9428,\n \"updated_at\": \"2022-02-16T17:54:35+00:00\",\n \"utm_campaign\": null,\n \"utm_content\": null,\n \"utm_medium\": null,\n \"utm_source\": null,\n \"utm_term\": null\n}\n```","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"the-response-object-1","slugUpdatedAt":"2022-03-18T16:14:19.040Z","revision":17,"_id":"62349c75be46080018e93060","pendingAlgoliaPublish":false,"createdAt":"2022-03-18T14:51:33.588Z","updatedAt":"2024-12-16T17:27:11.203Z","user":"6438061450131600110f7747","category":{"title":"Fairing API","slug":"enquirelabs-api","order":8,"reference":true,"_id":"6220bbe23ea59300135fe5d2","project":"5f9c809a8a28490012254347","version":"5f9c809a8a2849001225434e","createdAt":"2022-03-03T13:00:18.568Z","__v":0,"type":"reference","id":"6220bbe23ea59300135fe5d2"},"project":"5f9c809a8a28490012254347","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"pdfStatus":"","_id":"5f9c809a8a2849001225434e","project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"__v":1,"parentDoc":"6220bf448be6c7003d11b594","lastUpdatedHash":"0c4c1233a7b91afae06ec4f347609f64b1f2b76e","isApi":false,"tutorials":[],"id":"62349c75be46080018e93060"},"glossaryTerms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"hideTOC":false,"loginUrl":"https://dash.readme.com/to/fairing","meta":{"_id":"62349c75be46080018e93060","description":"The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the custom...","hidden":false,"image":[],"keywords":"","metaTitle":"The response object","parent":"6220bf448be6c7003d11b594","robots":"index","slug":"the-response-object","title":"The response object","type":"reference"},"oasDefinition":null,"oasPublicUrl":null,"oauth":false,"rdmd":{"baseUrl":"/","body":"The response object represents the information about a customer and order that is stored when a customer responds to a question. A response is created when a customer submits their answer to a question. Response data may be slightly different depending on the type of question presented to the customer.\n\n### Properties\n\n[block:html]\n{\n \"html\": \"<style>\\n .object-props-list .object-prop__name {\\n font-weight: bold;\\n margin: 0;\\n padding: 8px 0;\\n }\\n \\n .object-prop__name code {\\n font-style: normal;\\n }\\n\\n .object-prop__desc + .object-prop__name {\\n padding-top: 15px;\\n border-top: 1px solid hsl(213, 24%, 91%);\\n }\\n\\n .object-prop__type {\\n color: hsl(216, 13%, 58%);\\n font-size: 14px;\\n font-style: normal;\\n font-weight: normal;\\n }\\n\\n .object-props-list .object-prop__desc,\\n .object-props-list dd.object-prop__desc {\\n margin: 0;\\n margin-inline-start: inherit;\\n padding: 0 0 16px;\\n }\\n</style>\\n\\n\\n<dl class=\\\"object-props-list\\\">\\n <dt class=\\\"object-prop__name\\\">\\n <code>id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The unique ID of the response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>available_responses</code> <em class=\\\"object-prop__type\\\">array of string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The list of response choices that were available to the customer at the time they provided the response.\\n </dd> \\n <dt class=\\\"object-prop__name\\\">\\n <code>clarification_question</code> <em class=\\\"object-prop__type\\\">boolean</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The question for this response was a clarification of a previous question if <code>true</code>.\\n </dd>\\n\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_amount</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The discount amount applied to the order from the coupon.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_code</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The coupon code used on the order.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>coupon_type</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The coupon type used on the order. For Shopify orders, this will be either <code>fixed</code> or <code>percentage</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>customer_id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of customer associated with the order for this response. For Shopify orders, this matches the customer's ID in Shopify.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>customer_order_count</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The total number of orders the customer had at the time they placed the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>email</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The email address of the customer associated with the order for this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>inserted_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the time the response was created.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>landing_page_path</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The first click landing page associated with the order for this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_currency_code</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The three-letter ISO 4217 currency code of the order.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_id</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_number</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order number of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_platform</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The platform that provided the order information. For Shopify, this will be <code>shopify</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_source</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The source of the order. For Shopify, this will be <code>shopify_checkout</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_total</code> <em class=\\\"object-prop__type\\\">number</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order total in the currency used for payment by the customer.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>order_total_usd</code> <em class=\\\"object-prop__type\\\">number</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The order total in U.S. Dollars.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>original_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the response was edited, this will be the value of the original response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>other</code> <em class=\\\"object-prop__type\\\">boolean</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n Indicates if the response was free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>other_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the response was free-form text, the value of the text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The text value of the question associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the question associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>question_type</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The type of the question associated with this response. One of, <code>single_response</code>, <code>multi_response</code>, <code>auto_suggest</code>, <code>date</code>, <code>nps</code> or <code>open_ended</code>.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the text value of the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the ID of the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the text value of the response provided to the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_question_response_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n If the question associated with this response is a clarification question, the ID of the response provided to the question immediately preceeding this one.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>referring_site</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The referring site of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The text value of the response. This will be <code>null</code> if the response was free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_id</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The ID of the response if it was not free-form text.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_position</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The position of this response in the list of all responses to the associated question at the time it was presented to the customer. If the order of responses for a question is configured to be randomized, this value will not always be the same for the same response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>response_provided_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the time the response was provided by the customer.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>submit_delta</code> <em class=\\\"object-prop__type\\\">integer</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The time, in milliseconds, bewtween when the question was displayed and the response was submitted.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>updated_at</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n ISO 8601 timestamp of the last time the response was updated.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_campaign</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM campaign of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_content</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM content of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_medium</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM medium of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_source</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM source of the order associated with this response.\\n </dd>\\n <dt class=\\\"object-prop__name\\\">\\n <code>utm_term</code> <em class=\\\"object-prop__type\\\">string</em>\\n </dt>\\n <dd class=\\\"object-prop__desc\\\">\\n The UTM term of the order associated with this response.\\n </dd>\\n</dl>\"\n}\n[/block]\n\n\n### Example response object\n\n```json\n{\n \"available_responses\": [\n \"Podcast\",\n \"Billboard\",\n \"Subway Ad\"\n ],\n \"clarification_question\": false,\n \"coupon_amount\": \"10.00\",\n \"coupon_code\": \"SAVE10\",\n \"coupon_type\": \"fixed_amount\",\n \"customer_id\": \"3445695217710\",\n \"customer_order_count\": 17,\n \"email\": \"customer@example.com\",\n \"id\": \"ENz45Kvbxru0B5X6kDN7Y\",\n \"inserted_at\": \"2022-02-16T17:54:35+00:00\",\n \"landing_page_path\": \"/products/sale\",\n \"order_currency_code\": \"USD\",\n \"order_id\": \"4104320450606\",\n \"order_number\": \"1301\",\n \"order_platform\": \"shopify\",\n \"order_source\": \"shopify_checkout\",\n \"order_total\": \"57.71\",\n \"order_total_usd\": \"57.71\",\n \"other\": false,\n \"other_response\": null,\n \"question\": \"How did you hear about us?\",\n \"question_id\": 11,\n \"question_type\": \"single_response\",\n \"referring_question\": null,\n \"referring_question_id\": null,\n \"referring_question_response\": null,\n \"referring_question_response_id\": null,\n \"referring_site\": \"https://google.com\",\n \"response\": \"Podcast\",\n \"response_id\": 11747,\n \"response_position\": 1,\n \"response_provided_at\": \"2022-02-16T17:54:34Z\",\n \"submit_delta\": 9428,\n \"updated_at\": \"2022-02-16T17:54:35+00:00\",\n \"utm_campaign\": null,\n \"utm_content\": null,\n \"utm_medium\": null,\n \"utm_source\": null,\n \"utm_term\": null\n}\n```","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","baseUrl":"/","terms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]}},"terms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]},"mdx":false},"slugUrl":"/reference/the-response-object","suggestedEdits":true,"variables":{"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}],"user":{}},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.250.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"variables":{"user":{},"defaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}]},"project":{"_id":"5f9c809a8a28490012254347","appearance":{"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#0265DE","main_alt":"","header_text":"","body_highlight":"","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"global_landing_page":{"html":"","redirect":""},"referenceLayout":"row","link_logo_to_url":true,"theme":"line","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"logo":["https://files.readme.io/f01dca6-fairing-logo-h-24px.svg","fairing-logo-h-24px.svg",82,24,"#1e233c"],"logo_white":["https://files.readme.io/1a33247-small-Fairing_full_logo_white.png","Fairing full logo white.png",221,80,"#ffffff","https://files.readme.io/9bb7414-Fairing_full_logo_white.png"],"logo_white_use":false,"favicon":["https://files.readme.io/f6dd52b-small-Logo-Turquoise.png","Logo-Turquoise.png",32,32,"#264355","https://files.readme.io/a2813ef-Logo-Turquoise.png"],"stylesheet":"","stylesheet_hub2":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":false,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"search","buttonPrimary":"get-started","buttonSecondary":"docs"},"title":"Fairing Knowledge Center","text":"Welcome to the Fairing Knowledge Center. You'll find comprehensive guides and documentation to help you start working with Fairing as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"5f9c809a8a28490012254349"}],"showMetricsInReference":false,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":true,"colorScheme":"system","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"docs.fairing.co","childrenProjects":[],"derivedPlan":"startup2018","description":"Fairing Documentation. Learn how to use Fairing to set up your Question Stream, ask the right survey questions, and integrate with your existing technology and marketing stack.","error404":"","experiments":[],"first_page":"docs","flags":{"allow_hub2":false,"enterprise":false,"alwaysShowDocPublishStatus":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"oauth":false,"swagger":false,"correctnewlines":false,"rdmdCompatibilityMode":false,"speedyRender":false,"allowXFrame":false,"cookieAuthentication":false,"hideGoogleAnalytics":false,"newEditor":true,"oldMarkdown":false,"newMarkdownBetaProgram":true,"newApiExplorer":true,"disableAnonForum":false,"directGoogleToStableVersion":false,"translation":false,"staging":false,"newSearch":true,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"auth0Oauth":false,"newHeader":false,"referenceRedesign":false,"graphql":false,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":false,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":false,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":false,"apiDesigner":false,"hideEnforceSSO":false,"maskErrorMessages":true},"fullBaseUrl":"https://docs.fairing.co/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":true,"intercom":"uan21vw7","is_active":true,"integrations":{"login":{}},"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"docs","alignment":"left","pageType":"Documentation"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":true,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"name":"Fairing","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"api":true,"appearance":false,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":true,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":true,"points":2}},"percentScore":37.5,"totalScore":165},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":true},"stable":{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"subdomain":"fairing","subpath":"","superHubWaitlist":true,"topnav":{"left":[{"type":"url","text":"Changelog","url":"https://fairing.canny.io/changelog"},{"type":"url","text":"Status","url":"https://status.fairing.co"}],"right":[{"type":"url","url":"https://docs.fairing.co/page/support","text":"Contact Us"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2020-11-13T21:07:38.376Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://fairing.co/","versions":[{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1}],"variableDefaults":[{"source":"security","_id":"62fecaf83550a302c66cb5b2","name":"Authorization","type":"apiKey","apiSetting":"6220bbe23ea59300135fe5d0"},{"source":"security","_id":"62fecb07c35f8a0027ed276f","name":"api_key","type":"apiKey","apiSetting":"621fb031cf03a2001aa4129f"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"5fb2dd0ba42ac6004bafcb59","term":"DFC","definition":"Direct-From-Consumer"},{"_id":"5fc7ad3e5a8c65001822b4cd","term":"zero-party data","definition":"Zero party data is data that is given to you by your customers."}],"canonical_url":null,"description":"Fairing Documentation. Learn how to use Fairing to set up your Question Stream, ask the right survey questions, and integrate with your existing technology and marketing stack.","homepage_url":"https://fairing.co/","id":"5f9c809a8a28490012254347","name":"Fairing","parent":null,"redirects":[],"sitemap":"disabled","subdomain":"fairing","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"Authorization","source":"security","type":"apiKey","id":"62fecaf83550a302c66cb5b2"},{"name":"api_key","source":"security","type":"apiKey","id":"62fecb07c35f8a0027ed276f"}],"webhooks":[],"api_designer":{"allow_editing":"enabled"},"custom_login":{"login_url":null,"logout_url":null},"features":{"custom_components":"disabled","mdx":"disabled"},"onboarding_completed":{"api":true,"appearance":false,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"refactored":{"status":"disabled","migrated":"unknown"},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"disabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"enabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2020-11-13T21:07:38.376Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"aws":{"readme_webhook_login":{"region":null,"external_id":null,"role_arn":null,"usage_plan_id":null}},"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":"uan21vw7","secure_mode":{"key":null,"email_only":true}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#0265DE","link_color":null,"theme":"system"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"large","dark_mode":{"uri":null,"url":"https://files.readme.io/1a33247-small-Fairing_full_logo_white.png","name":"Fairing full logo white.png","width":221,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/9bb7414-Fairing_full_logo_white.png"}},"main":{"uri":null,"url":"https://files.readme.io/f01dca6-fairing-logo-h-24px.svg","name":"fairing-logo-h-24px.svg","width":82,"height":24,"color":"#1e233c","links":{"original_url":null}},"favicon":{"uri":null,"url":"https://files.readme.io/f6dd52b-small-Logo-Turquoise.png","name":"Logo-Turquoise.png","width":32,"height":32,"color":"#264355","links":{"original_url":"https://files.readme.io/a2813ef-Logo-Turquoise.png"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"documentation","left":[{"type":"link_url","title":"Changelog","url":"https://fairing.canny.io/changelog","custom_page":null},{"type":"link_url","title":"Status","url":"https://status.fairing.co","custom_page":null}],"logo_link":"homepage","right":[{"type":"link_url","title":"Contact Us","url":"https://docs.fairing.co/page/support","custom_page":null}],"sub_nav":[],"subheader_layout":"links","version":"disabled","links":{"home":{"label":"Home","visibility":"disabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":"Documentation","visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1}},"reqUrl":"/reference/the-response-object","version":{"_id":"5f9c809a8a2849001225434e","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5f9c809a8a28490012254350","5f9c809a8a28490012254350","5fa0318c300535004df4438b","5fa031935c0d18004df4d29c","5fa031b47970cc001e62665e","5fa031b7158c71004ae860bd","5fa158f705478c0012bd39d3","5fa3f7f8f62c47004fadc4ef","61424894389be2012719f36f","614249d5c18e5500792e9494","619e689de5d14a03042fb4e5","61a4e7354b35830018f692d7","621fb031cf03a2001aa412a1","6220bbe23ea59300135fe5d2","6220beafe6275701a32ceb5d","622ccc248ec9c6005f750b94","6376bf3a127d9900031710dc"],"project":"5f9c809a8a28490012254347","releaseDate":"2020-10-30T21:07:38.480Z","createdAt":"2020-10-30T21:07:38.480Z","__v":1},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>!function(){var analytics=window.analytics=window.analytics||[];if(!analytics.initialize)if(analytics.invoked)window.console&&console.error&&console.error("Segment snippet included twice.");else{analytics.invoked=!0;analytics.methods=["trackSubmit","trackClick","trackLink","trackForm","pageview","identify","group","track","ready","alias","page","once","off","on"];analytics.factory=function(t){return function(){var e=Array.prototype.slice.call(arguments);e.unshift(t);analytics.push(e);return analytics}};for(var t=0;t<analytics.methods.length;t++){var e=analytics.methods[t];analytics[e]=analytics.factory(e)}analytics.load=function(t){var e=document.createElement("script");e.type="text/javascript";e.async=!0;e.src=("https:"===document.location.protocol?"https://":"http://")+ "cdn.segment.com" +"/analytics.js/v1/"+t+"/analytics.min.js";var n=document.getElementsByTagName("script")[0];n.parentNode.insertBefore(e,n)};analytics.SNIPPET_VERSION="3.0.1"; analytics.load("vVXs3ulEHUSURX26E9Czo6oHLB1sqzy1"); }}(); </script><script>!function(t){if(window.ko)return;window.ko=[],["identify","track", "removeListeners", "open", "on", "off", "qualify", "ready"].forEach(function(t){ko[t]=function(){var n=[].slice.call(arguments);return n.unshift(t),ko.push(n),ko}});var n=document.createElement("script");n.async=!0,n.setAttribute("src","https://cdn.getkoala.com/v1/pk_741b7c53479f5b226a1ab43eeebbbd1df161/sdk.js"),(document.body || document.head).appendChild(n)}(); $(window).on('pageLoad', function(e, state){ try { const me = JSON.parse(document.getElementById('hub-me').dataset.json); const email = me.user && me.user.email; if (email) { ko.identify(email); } } catch (e) {} });</script><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,734,5312,6903,2395,6522,697,73,777,3108,2852,9930,7783,1456,4935,4287,4201,1936,5798,1666,9553,153,1313,1343,6922,3906,2447,9575,6060,4002,3787,2578,3859,8063,1080,9852,8684,2144,2637,4674,1731,678,5408,2402,1202,4467,9141,3221,7327,7285,3307,1948,2616,3412,8899,7031,4793]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Doc","Footer","routes-PageNotFound","routes-Reference","core-icons-more-vertical-svg","CustomPage","core-icons-arrow-right-svg","core-icons-lock-svg","routes-Landing","core-icons-eye-off-svg","core-icons-chevron-down-svg","core-icons-arrow-up-right-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-Changelog","List","core-icons-webhook-svg","routes-Discuss","Page","core-icons-alert-circle-svg","routes-Tutorials","Post","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","core-icons-trending-up-svg","core-icons-callout-info-svg","New","routes-CustomPage","core-icons-message-circle-svg","core-icons-star-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.ad529c3d39e40f72e3f8.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.684e6481786a2c9a53de.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.e8c079b3df984cab2b40.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/734.b705fc2010420612d252.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6903.75b9333e2c99d6924d0e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.5f04db368eee8f70d81b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/697.c7df71558ebc8a75b523.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/73.c91a16995ea193a8705d.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/777.62bdcb0e49d755651783.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3108.471d4a1c3077afe27478.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.c1a2ae7970da644925ea.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/9930.8ac6b4156bf4ee8644e6.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.f038db7b1e3ac1460fe5.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.21bfe108dc2a9fd8187f.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4287.916cdd386055d2c5d238.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/4201.0a317d4e2bf3cde90317.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.cef380c3e211d2ea6e51.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.9802bfeceb2dceb6e206.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.9d9eb8df4877b777c42d.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/9553.cb407a77300a2dd958e4.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e58189ce91340b95c433.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d035c3329df9585fa7d6.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/3906.62f576269c8b3253048f.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/CustomPage.b74c02c4ec3b054bb9d5.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.979bb00f878b2fa579a6.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.3ccf9f42effebdfd9cbf.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.54cd06e135d3ee0dbc93.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.071c7febd301fb6e2a4d.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.879f8fb13a34fcccd2a3.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.05c5c00809eab74a8061.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.e0529587af8819bc68f0.js"></script> <script async data-chunk="core-icons-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.2deb29c12d09bcad8fb2.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.f9e258d171c801c1a67d.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.da2e00e975cc6d1926d1.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.c5776db0e83892adab6f.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.2edfa94f1d90a641f339.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.3f65c21b3eb3f03cbaa5.js"></script> <script async data-chunk="core-icons-message-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-message-circle-svg.1e24c2d2eb4f9a6ede5d.js"></script> <script async data-chunk="core-icons-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.js"></script></div><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); </script><script>ga('create', 'UA-90823734-3', 'auto', {'name': 'custom'}); $(window).on('pageLoad', function(e, state){ ga('custom.send', 'pageview', window.location.pathname); }); </script><script>$(window).on('pageLoad', function(e, state){ analytics.page(window.location.pathname, state.meta.title, { "context": { "plugin": { "name": "readme_io", "version": "1.0.0" } } }) }); </script><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NDU2MjZlM2U2OWJiZGVlZmE4ODkwYjBmZjU0YTVhMTE0ZTM2ZDk1NTIwYWFlNzk3OWZmMjk5NjIxNDUxOThhY3RhZ0ZpbHRlcnM9KHByb2plY3Q6NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzQ3KSwodmVyc2lvbjpub25lLHZlcnNpb246NWY5YzgwOWE4YTI4NDkwMDEyMjU0MzRlKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:5f9c809a8a28490012254347),(version:none,version:5f9c809a8a2849001225434e),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":false,"docs":true,"examples":true,"reference":true,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":true,"tutorials":false,"graphql":false},"id":"5f9c809a8a28490012254347","name":"Fairing","subdomain":"fairing","subpath":"","nav_names":{"docs":"Documentation","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]},"intercom":{"intercom":"uan21vw7","intercom_secure_emailonly":true}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>

CINXE.COM

The response object