Skip to main content
POST
Add new Competitor Aggregation URL

Headers

Accept
string

e.g. application/json

x-api-key
string

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

Path Parameters

businessNumber
number
required

Id of the business.

compAccountId
number
required

Competitor Account Id.

Body

application/json
sourceAlias
string
required

Source alias.

url
string

da-vittorio-san-francisco (string, required) - Source url to be added.

Response

OK

id
number

Id of the created Aggregation.

sourceAlias
string

Alias of the source.

sourceName
string

Name of the source.

sourceUrl
string

da-vittorio-san-francisco (string) - Url of the souce.

sourceId
number

Id of the source.

compAccountId
number

Competitor account id.

Body
string

{ "id": 140179308, "sourceId": 2, "compAccountId": 1765, "sourceUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476", "sourceName": "Google", "thumbnailUrl": "source/icons/2.png", "backGroundColor": "#dd4b39", "textColor": "#ffffff", "userName": null, "password": null, "profileId": null, "reviewFormUrl": "https://www.google.com/maps/place/Rama+Sai+Medical+Store/@28.4390976,76.9596497,11z/data=!4m8!1m2!2m1!1sreviews+google!3m4!1s0x390d04b550d23f2d:0x7e948cb85612d0!8m2!3d28.61074!4d77.0798476", "aggregationStatus": 3, "sourceAlias": "google", "disabledAggregation": null, "disabledAggregationReason": null }