{"id":128,"date":"2024-11-26T11:11:29","date_gmt":"2024-11-26T05:41:29","guid":{"rendered":"https:\/\/surveybackoffice.com\/help\/?page_id=128"},"modified":"2024-11-26T12:32:56","modified_gmt":"2024-11-26T07:02:56","slug":"sbo-apis-surveys","status":"publish","type":"page","link":"https:\/\/surveybackoffice.com\/help\/sbo-apis-surveys\/","title":{"rendered":"Survey Insights API"},"content":{"rendered":"\n

\n\t\tSetup Of API\n\t<\/h2>\n\t

To use SBO’s Survey Insights API, you can follow the below steps:-<\/h5>\n
    \n
  1. Goto Your\u00a0Company’s Accounts Profile Page<\/a><\/li>\n
  2. Add An API Password and Save<\/li>\n
  3. Goto\u00a0Edit Company (client\/vendor)<\/a><\/li>\n
  4. Under the “SBO’s Insights Exchange API” section add ALL under “Show Projects or Redirection Insights”<\/li>\n
  5. Now share the below credentials with your companies\n
      \n
    1. From Company’s Accounts Profile Page, share\u00a0“API’s User Name & API Password”<\/b><\/li>\n
    2. From Company’s Edit Page, share\u00a0“Secret API Key”<\/b><\/li>\n<\/ol>\n<\/li>\n
    3. Now share the urls (links) credentials with your companies. Base link must be https:\/\/api.surveybackoffice.com\/\n
        \n
      1. Add on link for getting list of survey\u00a0surveys<\/b>\u00a0where ### is must be the project number
        \nSo the full link must be\u00a0https:\/\/api.surveybackoffice.com\/surveys<\/b><\/li>\n<\/ol>\n<\/li>\n
      2. Along with sharing the above credentials the company (user) using the api also needs to set some api headers\n
          \n
        1. First the header KEY must be\u00a0app-name<\/b>\u00a0and it’s value must be\u00a0surey back office<\/b><\/li>\n
        2. Second the header KEY must be\u00a0app-auth-user<\/b>\u00a0and it’s value must be\u00a0[API’s Username]<\/b>\u00a0(shared from the first credential)<\/li>\n
        3. Third the header KEY must be\u00a0app-auth-pwd<\/b>\u00a0and it’s value must be\u00a0[API Password]<\/b>\u00a0(shared from the first credential)<\/li>\n
        4. Fourth the header KEY must be\u00a0secret-key<\/b>\u00a0and it’s value must be\u00a0[Secret API Key]<\/b>\u00a0(shared from the second credential)<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n

          \n\t\tFilters & Ordering\n\t<\/h2>\n\t

          The SBO (Survey Back Office) Insights Exchange<\/strong> APIs facilitates the developers to filter and order the api’s response data. To use the same, the developer need to pass api headers with their relative key and value(s).<\/p>\n

            \n
          • For filtering data<\/strong>, the developer needs to add api-addon-where <\/strong>as key and “field\/column name equals to value” as value. Note this filters are addon filters and it won’t overwrite the mandatory where conditions of the apis. Let’s check an example, let’s say you want to filter surveys based on the country america then your api headers must contain api-addon-where: country_name like “%America%”<\/strong><\/li>\n
          • For ordering data<\/strong>, the developer needs to add api-order <\/strong>as key and “field\/column” as value. Note:- This will overwrite the default order of the api. Now lets check an example, let’s say you want to order data based on project name then your api headers must contain api-order: project_name”<\/strong><\/li>\n<\/ul>\n

            Note: To know the field\/column names you can refer the data that is provided by the api.<\/p>\n

            \n\t\tImage Of Sample Setup Done in Postman :-\n\t<\/h4>\n\t\t\t\t\"Survey\n\n","protected":false},"excerpt":{"rendered":"

            Setup Of API To use SBO’s Survey Insights API, you can follow the below steps:- Goto Your\u00a0Company’s Accounts Profile Page […]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"boxed","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-gradient":""}},"footnotes":""},"_links":{"self":[{"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/pages\/128"}],"collection":[{"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/comments?post=128"}],"version-history":[{"count":7,"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/pages\/128\/revisions"}],"predecessor-version":[{"id":150,"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/pages\/128\/revisions\/150"}],"wp:attachment":[{"href":"https:\/\/surveybackoffice.com\/help\/wp-json\/wp\/v2\/media?parent=128"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}