MCPSocial Open URL Performance Report
curl --request POST \
--url https://api.birdeye.com/resources/v1/social/open-url/performance/report \
--header 'Content-Type: application/json' \
--data '
{
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"sourceNames": [
"Instagram",
"Tiktok",
"Facebook",
"Linkedin"
],
"businessNumbers": [],
"comparisonFilter": {
"startDate": "01/01/2020",
"endDate": "01/10/2020"
},
"page": 1,
"size": 50
}
'import requests
url = "https://api.birdeye.com/resources/v1/social/open-url/performance/report"
payload = {
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"sourceNames": ["Instagram", "Tiktok", "Facebook", "Linkedin"],
"businessNumbers": [],
"comparisonFilter": {
"startDate": "01/01/2020",
"endDate": "01/10/2020"
},
"page": 1,
"size": 50
}
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: '02/03/2021',
endDate: '02/10/2026',
sourceNames: ['Instagram', 'Tiktok', 'Facebook', 'Linkedin'],
businessNumbers: [],
comparisonFilter: {startDate: '01/01/2020', endDate: '01/10/2020'},
page: 1,
size: 50
})
};
fetch('https://api.birdeye.com/resources/v1/social/open-url/performance/report', 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/social/open-url/performance/report",
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' => '02/03/2021',
'endDate' => '02/10/2026',
'sourceNames' => [
'Instagram',
'Tiktok',
'Facebook',
'Linkedin'
],
'businessNumbers' => [
],
'comparisonFilter' => [
'startDate' => '01/01/2020',
'endDate' => '01/10/2020'
],
'page' => 1,
'size' => 50
]),
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/social/open-url/performance/report"
payload := strings.NewReader("{\n \"startDate\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\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/social/open-url/performance/report")
.header("Content-Type", "application/json")
.body("{\n \"startDate\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/social/open-url/performance/report")
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\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"actual": {
"impressions": 11363,
"engagements": 1421,
"engRate": 12.51,
"postCount": 4479,
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 321,
"impressions": 9194,
"engRate": 3.49
},
"instagram": {
"totalPost": 4479,
"engagements": 1100,
"impressions": 2169,
"engRate": 50.71
}
},
"totalRecords": 6,
"postCountGrowthPercent": 100,
"engRateGrowthPercent": 100,
"engagementGrowthPercent": 100
},
"compare": {
"impressions": 0,
"engagements": 0,
"engRate": 0,
"postCount": 0,
"channelWiseData": {},
"totalRecords": 0
}
},
"dataPoints": [
{
"actual": {
"label": "nesh",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 407984,
"businessNumber": 151378841664132,
"externalReferenceId": "1104900901",
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 143,
"impressions": 3902,
"engRate": 3.66
}
}
},
"compare": {
"label": "nesh",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 407984,
"businessNumber": 151378841664132,
"externalReferenceId": "1104900901",
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 143,
"impressions": 3902,
"engRate": 3.66
}
}
}
},
{
"actual": {
"label": "Business",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 948224,
"businessNumber": 166063705866724,
"externalReferenceId": "1104900901",
"channelWiseData": {
"instagram": {
"totalPost": 3669,
"engagements": 836,
"impressions": 618,
"engRate": 135.28
}
}
},
"compare": {
"label": "Business",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 948224,
"businessNumber": 166063705866724,
"externalReferenceId": "1104900901",
"channelWiseData": {
"instagram": {
"totalPost": 3669,
"engagements": 836,
"impressions": 618,
"engRate": 135.28
}
}
}
},
{
"actual": {
"label": "vulk loc ag",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 972854,
"businessNumber": 166520715464268,
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 178,
"impressions": 5292,
"engRate": 3.36
}
}
},
"compare": {}
}
]
}{
"code": 400,
"message": "Invalid media id"
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}Social
Social Open URL Performance Report
Social Open URL Performance Report API returns channel-level social performance metrics with optional comparison data for the selected date range.
POST
/
v1
/
social
/
open-url
/
performance
/
report
Social Open URL Performance Report
curl --request POST \
--url https://api.birdeye.com/resources/v1/social/open-url/performance/report \
--header 'Content-Type: application/json' \
--data '
{
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"sourceNames": [
"Instagram",
"Tiktok",
"Facebook",
"Linkedin"
],
"businessNumbers": [],
"comparisonFilter": {
"startDate": "01/01/2020",
"endDate": "01/10/2020"
},
"page": 1,
"size": 50
}
'import requests
url = "https://api.birdeye.com/resources/v1/social/open-url/performance/report"
payload = {
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"sourceNames": ["Instagram", "Tiktok", "Facebook", "Linkedin"],
"businessNumbers": [],
"comparisonFilter": {
"startDate": "01/01/2020",
"endDate": "01/10/2020"
},
"page": 1,
"size": 50
}
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: '02/03/2021',
endDate: '02/10/2026',
sourceNames: ['Instagram', 'Tiktok', 'Facebook', 'Linkedin'],
businessNumbers: [],
comparisonFilter: {startDate: '01/01/2020', endDate: '01/10/2020'},
page: 1,
size: 50
})
};
fetch('https://api.birdeye.com/resources/v1/social/open-url/performance/report', 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/social/open-url/performance/report",
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' => '02/03/2021',
'endDate' => '02/10/2026',
'sourceNames' => [
'Instagram',
'Tiktok',
'Facebook',
'Linkedin'
],
'businessNumbers' => [
],
'comparisonFilter' => [
'startDate' => '01/01/2020',
'endDate' => '01/10/2020'
],
'page' => 1,
'size' => 50
]),
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/social/open-url/performance/report"
payload := strings.NewReader("{\n \"startDate\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\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/social/open-url/performance/report")
.header("Content-Type", "application/json")
.body("{\n \"startDate\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.birdeye.com/resources/v1/social/open-url/performance/report")
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\": \"02/03/2021\",\n \"endDate\": \"02/10/2026\",\n \"sourceNames\": [\n \"Instagram\",\n \"Tiktok\",\n \"Facebook\",\n \"Linkedin\"\n ],\n \"businessNumbers\": [],\n \"comparisonFilter\": {\n \"startDate\": \"01/01/2020\",\n \"endDate\": \"01/10/2020\"\n },\n \"page\": 1,\n \"size\": 50\n}"
response = http.request(request)
puts response.read_body{
"summary": {
"actual": {
"impressions": 11363,
"engagements": 1421,
"engRate": 12.51,
"postCount": 4479,
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 321,
"impressions": 9194,
"engRate": 3.49
},
"instagram": {
"totalPost": 4479,
"engagements": 1100,
"impressions": 2169,
"engRate": 50.71
}
},
"totalRecords": 6,
"postCountGrowthPercent": 100,
"engRateGrowthPercent": 100,
"engagementGrowthPercent": 100
},
"compare": {
"impressions": 0,
"engagements": 0,
"engRate": 0,
"postCount": 0,
"channelWiseData": {},
"totalRecords": 0
}
},
"dataPoints": [
{
"actual": {
"label": "nesh",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 407984,
"businessNumber": 151378841664132,
"externalReferenceId": "1104900901",
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 143,
"impressions": 3902,
"engRate": 3.66
}
}
},
"compare": {
"label": "nesh",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 407984,
"businessNumber": 151378841664132,
"externalReferenceId": "1104900901",
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 143,
"impressions": 3902,
"engRate": 3.66
}
}
}
},
{
"actual": {
"label": "Business",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 948224,
"businessNumber": 166063705866724,
"externalReferenceId": "1104900901",
"channelWiseData": {
"instagram": {
"totalPost": 3669,
"engagements": 836,
"impressions": 618,
"engRate": 135.28
}
}
},
"compare": {
"label": "Business",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 948224,
"businessNumber": 166063705866724,
"externalReferenceId": "1104900901",
"channelWiseData": {
"instagram": {
"totalPost": 3669,
"engagements": 836,
"impressions": 618,
"engRate": 135.28
}
}
}
},
{
"actual": {
"label": "vulk loc ag",
"startDate": "02/03/2021",
"endDate": "02/10/2026",
"locationId": 972854,
"businessNumber": 166520715464268,
"channelWiseData": {
"tiktok": {
"totalPost": 0,
"engagements": 178,
"impressions": 5292,
"engRate": 3.36
}
}
},
"compare": {}
}
]
}{
"code": 400,
"message": "Invalid media id"
}{
"code": 1161,
"message": "Invalid API key"
}{
"code": 89,
"message": "Rate limit exceeded"
}Headers
e.g. application/json
e.g. [Required] Partner specific API key provided by Birdeye for data exchange.
e.g. [Required] Business number of the location.
Media type of the JSON request body.
Body
application/json
Start date in MM/dd/YYYY format.
End date in MM/dd/YYYY format.
List of social channels to include in the report.
List of business numbers to filter the report. If empty, all accessible business numbers are considered.
Comparison date range.
Show child attributes
Show child attributes
Page number for location-level data points.
Number of records per page.