List Survey Responses

List Responses for a Survey

curl --request POST \
  --url https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "07/03/2018 06:30:00",
  "endDate": "07/23/2018 06:45:00"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}"

payload = {
    "startDate": "07/03/2018 06:30:00",
    "endDate": "07/23/2018 06:45:00"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({startDate: '07/03/2018 06:30:00', endDate: '07/23/2018 06:45:00'})
};

fetch('https://api.birdeye.com/resources/v1/survey/ext/list/responses/{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/ext/list/responses/{survey_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startDate' => '07/03/2018 06:30:00',
    'endDate' => '07/23/2018 06:45:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}"

	payload := strings.NewReader("{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
}

POST

survey

ext

list

responses

{survey_id}

List Responses for a Survey

curl --request POST \
  --url https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "07/03/2018 06:30:00",
  "endDate": "07/23/2018 06:45:00"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}"

payload = {
    "startDate": "07/03/2018 06:30:00",
    "endDate": "07/23/2018 06:45:00"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({startDate: '07/03/2018 06:30:00', endDate: '07/23/2018 06:45:00'})
};

fetch('https://api.birdeye.com/resources/v1/survey/ext/list/responses/{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/ext/list/responses/{survey_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'startDate' => '07/03/2018 06:30:00',
    'endDate' => '07/23/2018 06:45:00'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}"

	payload := strings.NewReader("{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}")
  .header("Content-Type", "application/json")
  .body("{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/survey/ext/list/responses/{survey_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"startDate\": \"07/03/2018 06:30:00\",\n  \"endDate\": \"07/23/2018 06:45:00\"\n}"

response = http.request(request)
puts response.read_body

{
  "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

string

e.g. application/json

x-api-key

string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

Path Parameters

survey_id

integer

required

Id of the Survey.

Query Parameters

businessNumber

string

required

The Business Number of Enterprise

page

integer

The page number, starts with 0.

size

integer

The size of the page.

sortby

string

The sort by parameter.

sorder

string

The sort order parameter.

includeTicketId

boolean

The field to fetch ticketIds associated with the response.

Body

application/json

startDate

string

Start date.

endDate

string

End date.

Overview

Business

Custom Fields

User

Reviews

Contact

Contact V2

Campaign

Aggregation

Report

Survey

Business Media

Social

Employee

Conversation

Subscription

Webhook

Competitor

Competitor AI

Insight AI

Google Q&A

Google Services

FAQ

Listing

GMB Products

Search AI

Ticketing

Integration

List Survey Responses

Headers

Path Parameters

Query Parameters

Body

Response