Skip to main content
POST
Get Keyword Statistics

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

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.

Path Parameters

businessNumber
string
required

Account Business Number.

Body

application/json
sourceType
string

Type of source e.g. review [by default] or social.

sources
any[]

Aggregation sources.

timePeriodSelected
string

For all time : all.

startDate
string

Date from which data has to be fetched[MM/DD/YYYY].

endDate
string

Date until which data has to be fetched[MM/DD/YYYY].

competitors
object[]

List of competitors

topKW
number

Count of top Keywords to be fetched.

topAd
number

Count of top Adjectives to be fetched.

orderBy
string

Order of the result e.g.: "occurrence"[default] or "ztoa" or "atoz"

sentiment
number

-1 = negative sentiment,

Response

OK

id
number

Business Id

Example:

119468

name
string

Name of Enterprise

Example:

"Social Stress"

keywords
any[]

List of keywords.

ct
number

Count.

Example:

27159

avgScr
number

Average Score.

Example:

1

keywordStats
object[]
negKWAdjectives
object[]

Negative keyword details

competitors
object[]

Competitor details