Add Aggregation Link

Add new Competitor Aggregation URL

curl --request POST \
  --url https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber} \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceAlias": "citysearch ",
  "url": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}"

payload = {
    "sourceAlias": "citysearch ",
    "url": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
}
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({
    sourceAlias: 'citysearch ',
    url: 'http://www.citysearch.com/biz/maria-da-vittorio-san-francisco'
  })
};

fetch('https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}', 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/aggregation/competitor/{compAccountId}/{businessNumber}",
  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([
    'sourceAlias' => 'citysearch ',
    'url' => 'http://www.citysearch.com/biz/maria-da-vittorio-san-francisco'
  ]),
  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/aggregation/competitor/{compAccountId}/{businessNumber}"

	payload := strings.NewReader("{\n  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\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/aggregation/competitor/{compAccountId}/{businessNumber}")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}")

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  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\n}"

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

{
  "id": 237030543,
  "sourceAlias": "citysearch",
  "sourceName": "Citysearch",
  "sourceUrl": "http://www.citysearch.com/biz/maria",
  "sourceId": 2,
  "compAccountId": 1765,
  "Body": ""
}

{
  "code": 1161,
  "message": "Invalid API key"
}

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

POST

aggregation

competitor

{compAccountId}

{businessNumber}

Add new Competitor Aggregation URL

curl --request POST \
  --url https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber} \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceAlias": "citysearch ",
  "url": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
}
'

import requests

url = "https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}"

payload = {
    "sourceAlias": "citysearch ",
    "url": "http://www.citysearch.com/biz/maria-da-vittorio-san-francisco"
}
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({
    sourceAlias: 'citysearch ',
    url: 'http://www.citysearch.com/biz/maria-da-vittorio-san-francisco'
  })
};

fetch('https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}', 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/aggregation/competitor/{compAccountId}/{businessNumber}",
  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([
    'sourceAlias' => 'citysearch ',
    'url' => 'http://www.citysearch.com/biz/maria-da-vittorio-san-francisco'
  ]),
  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/aggregation/competitor/{compAccountId}/{businessNumber}"

	payload := strings.NewReader("{\n  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\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/aggregation/competitor/{compAccountId}/{businessNumber}")
  .header("Content-Type", "application/json")
  .body("{\n  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.birdeye.com/resources/v1/aggregation/competitor/{compAccountId}/{businessNumber}")

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  \"sourceAlias\": \"citysearch \",\n  \"url\": \"http://www.citysearch.com/biz/maria-da-vittorio-san-francisco\"\n}"

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

{
  "id": 237030543,
  "sourceAlias": "citysearch",
  "sourceName": "Citysearch",
  "sourceUrl": "http://www.citysearch.com/biz/maria",
  "sourceId": 2,
  "compAccountId": 1765,
  "Body": ""
}

{
  "code": 1161,
  "message": "Invalid API key"
}

{
  "code": 1011,
  "message": "Business id is invalid"
}

{
  "code": 89,
  "message": "Rate limit exceeded"
}

Headers

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

number

required

Id of the business.

compAccountId

number

required

Competitor Account Id.

Response

number

Id of the created Aggregation.

sourceAlias

string

Alias of the source.

sourceName

string

Name of the source.

sourceUrl

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 }

Get Started

Reference

Headers

Path Parameters

Response