Get Survey
curl --request GET \
--url https://api.birdeye.com/resources/v1/survey/{survey_id}import requests
url = "https://api.birdeye.com/resources/v1/survey/{survey_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/survey/{survey_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/survey/{survey_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/survey/{survey_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/survey/{survey_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/survey/{survey_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"surveyId": 535,
"logoUrl": "https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png",
"name": "JetBlue Customer Satisfaction Survey",
"status": "new",
"created": 1484941995000,
"lastModified": 1484941995000,
"responses": 0,
"questionCount": 4,
"pages": [
{
"name": "Introduction",
"id": 2316,
"order": 0,
"showQuestionNumbers": 1,
"visible": false,
"questions": [
{
"title": "Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us. Your feedback will help us improve the way we serve you",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10315,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 0,
"visible": true,
"isRequired": true,
"type": "label",
"reactElementId": 493,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "How was your trip today",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10314,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 1,
"visible": true,
"isRequired": true,
"type": "radio",
"reactElementId": 840,
"value": [],
"choices": [
{
"id": 22854,
"title": "Satified",
"order": 0
},
{
"id": 22856,
"title": "Needs Improvement",
"order": 1
},
{
"id": 22855,
"title": "Dissatiffied",
"order": 2
}
],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "Please rate us based on your experience",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10316,
"skipQuestion": false,
"displayQuestion": false,
"maximumRateDescription": "Excellent",
"minimumRateDescription": "Poor",
"minimumValue": 1,
"maximumValue": 10,
"order": 2,
"visible": true,
"isRequired": true,
"type": "rating",
"reactElementId": 101,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "Thanks for your feedback! Please let us know how we can serve you better",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10317,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 3,
"visible": true,
"isRequired": true,
"type": "textarea",
"reactElementId": 813,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
}
]
}
],
"supportedLocales": [],
"buttonTexts": [
{
"id": 2096,
"locale": "en",
"textKey": "Start",
"localeText": "Start"
},
{
"id": 2097,
"locale": "en",
"textKey": "Cancel",
"localeText": "Cancel"
},
{
"id": 2098,
"locale": "en",
"textKey": "Back",
"localeText": "Back"
},
{
"id": 2099,
"locale": "en",
"textKey": "Next",
"localeText": "Next"
},
{
"id": 2100,
"locale": "en",
"textKey": "Done",
"localeText": "Done"
},
{
"id": 2101,
"locale": "en",
"textKey": "Finish",
"localeText": "Finish"
},
{
"id": 2102,
"locale": "en",
"textKey": "Submit",
"localeText": "Submit"
},
{
"id": 2103,
"locale": "en",
"textKey": "notNow",
"localeText": "Not Now"
}
],
"businessId": 145301531829695
}{
"code": 1315,
"message": "Invalid survey."
}{
"code": 1167,
"message": "API key is missing"
}{
"code": 1011,
"message": "Business id is invalid"
}{
"code": 89,
"message": "Rate limit exceeded"
}Survey
Get
Get Survey fetches the survey designer page details for a particular survey. It provides all the questions which are available in the requested survey ID.
GET
/
v1
/
survey
/
{survey_id}
Get Survey
curl --request GET \
--url https://api.birdeye.com/resources/v1/survey/{survey_id}import requests
url = "https://api.birdeye.com/resources/v1/survey/{survey_id}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.birdeye.com/resources/v1/survey/{survey_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.birdeye.com/resources/v1/survey/{survey_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.birdeye.com/resources/v1/survey/{survey_id}"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.birdeye.com/resources/v1/survey/{survey_id}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/survey/{survey_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"surveyId": 535,
"logoUrl": "https://d2xt3xymj142xp.cloudfront.net/145301531829695/logo%2F57db1409813c70.82884191.png",
"name": "JetBlue Customer Satisfaction Survey",
"status": "new",
"created": 1484941995000,
"lastModified": 1484941995000,
"responses": 0,
"questionCount": 4,
"pages": [
{
"name": "Introduction",
"id": 2316,
"order": 0,
"showQuestionNumbers": 1,
"visible": false,
"questions": [
{
"title": "Thank you for traveling with JetBlue Airways! We’d love to hear about your recent trip with us. Your feedback will help us improve the way we serve you",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10315,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 0,
"visible": true,
"isRequired": true,
"type": "label",
"reactElementId": 493,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "How was your trip today",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10314,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 1,
"visible": true,
"isRequired": true,
"type": "radio",
"reactElementId": 840,
"value": [],
"choices": [
{
"id": 22854,
"title": "Satified",
"order": 0
},
{
"id": 22856,
"title": "Needs Improvement",
"order": 1
},
{
"id": 22855,
"title": "Dissatiffied",
"order": 2
}
],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "Please rate us based on your experience",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10316,
"skipQuestion": false,
"displayQuestion": false,
"maximumRateDescription": "Excellent",
"minimumRateDescription": "Poor",
"minimumValue": 1,
"maximumValue": 10,
"order": 2,
"visible": true,
"isRequired": true,
"type": "rating",
"reactElementId": 101,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
},
{
"title": "Thanks for your feedback! Please let us know how we can serve you better",
"name": "Question name",
"showQuestionNumbers": 1,
"id": 10317,
"skipQuestion": false,
"displayQuestion": false,
"minimumValue": 0,
"maximumValue": 0,
"order": 3,
"visible": true,
"isRequired": true,
"type": "textarea",
"reactElementId": 813,
"value": [],
"choices": [],
"rows": [],
"skipLogic": [],
"displayLogic": []
}
]
}
],
"supportedLocales": [],
"buttonTexts": [
{
"id": 2096,
"locale": "en",
"textKey": "Start",
"localeText": "Start"
},
{
"id": 2097,
"locale": "en",
"textKey": "Cancel",
"localeText": "Cancel"
},
{
"id": 2098,
"locale": "en",
"textKey": "Back",
"localeText": "Back"
},
{
"id": 2099,
"locale": "en",
"textKey": "Next",
"localeText": "Next"
},
{
"id": 2100,
"locale": "en",
"textKey": "Done",
"localeText": "Done"
},
{
"id": 2101,
"locale": "en",
"textKey": "Finish",
"localeText": "Finish"
},
{
"id": 2102,
"locale": "en",
"textKey": "Submit",
"localeText": "Submit"
},
{
"id": 2103,
"locale": "en",
"textKey": "notNow",
"localeText": "Not Now"
}
],
"businessId": 145301531829695
}{
"code": 1315,
"message": "Invalid survey."
}{
"code": 1167,
"message": "API key is missing"
}{
"code": 1011,
"message": "Business id is invalid"
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
Path Parameters
Id of the Survey.
Query Parameters
Id of the Business.
The survey locale, default is english
Response
OK
⌘I