0

Engagement Metrics

by
Published Oct 17, 2025

Returns engagement metrics information for the provided businesses. This endpoint requires special permissions to be enabled for your Yelp Fusion API Key.

Script yelp Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Yelp = {
3
  apiKey: string;
4
};
5
/**
6
 * Engagement Metrics
7
 * Returns engagement metrics information for the provided businesses.
8

9
  This endpoint requires special permissions to be enabled for your Yelp Fusion API Key.
10

11

12
 */
13
export async function main(
14
  auth: Yelp,
15
  business_ids: string | undefined,
16
  date_range_start: string | undefined,
17
  date_range_end: string | undefined,
18
) {
19
  const url = new URL(`https://api.yelp.com/v3/businesses/engagement`);
20
  for (const [k, v] of [
21
    ["business_ids", business_ids],
22
    ["date_range_start", date_range_start],
23
    ["date_range_end", date_range_end],
24
  ]) {
25
    if (v !== undefined && v !== "" && k !== undefined) {
26
      url.searchParams.append(k, v);
27
    }
28
  }
29
  const response = await fetch(url, {
30
    method: "GET",
31
    headers: {
32
      Authorization: "Bearer " + auth.apiKey,
33
    },
34
    body: undefined,
35
  });
36
  if (!response.ok) {
37
    const text = await response.text();
38
    throw new Error(`${response.status} ${text}`);
39
  }
40
  return await response.json();
41
}
42