Skip to main content
POST
Get Survey Usage by Location

Headers

x-business-number
string
required

The Business Number of the Enterprise.

time-zone-id
string
default:UTC

Timezone ID for date filtering. Defaults to UTC.

x-api-key
string
required

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

Content-Type
string
default:application/json

Media type of the JSON request body.

Accept
string
default:application/json

e.g. application/json

Path Parameters

surveyId
integer
required

Id of the Survey.

Query Parameters

page
integer
default:0

The page number, starts with 0.

size
integer
default:500

The number of records per page.

sortOrder
enum<string>
default:desc

Sort order for results. Results are always sorted by response count.

Available options:
asc,
desc

Body

application/json
startDate
string

Start date for filtering in ISO 8601 format.

endDate
string

End date for filtering in ISO 8601 format.

Response

OK