---
agentTools:
  projectIndex: https://docs.developer.yelp.com/llms.txt
---

# Engagement Metrics API

> 📘 This is a Yelp Partner API
>
> Access is disabled by default. See [Yelp Partner APIs](https://docs.developer.yelp.com/docs/yelp-partner-apis) on how to get access.

# Overview

The Engagement Metrics API returns a business’s consumer engagement score, by week, relative to all other North America-based businesses on Yelp.

# Access and Credentials

This API is reserved for Yelp Insights API partners. To inquire about becoming a Yelp Insights API partner please visit [here](https://knowledge.yelp.com/). Upon registration, the client will be permitted access to this endpoint. Credentials can be generated [here](https://www.yelp.com/developers/v3/manage_app).

# Authentication

Refer [here](https://docs.developer.yelp.com/docs/fusion-authentication) for more about authentication for this API

# Request

To use this endpoint, make the GET request to the following URL with at a minimum the business\_ids parameter.

```text
GET https://api.yelp.com/v3/businesses/engagement
```

Accepted parameters are listed below:

[block:parameters]
{
  "data": {
    "h-0": "Parameter name",
    "h-1": "Description",
    "h-2": "Example",
    "0-0": "business_ids",
    "0-1": "Comma separated list of Yelp business id of the locations you'd like metrics for. Maximum of 20 business_ids per request.",
    "0-2": "nBvdJyM7TCHp5ppX31SC5Q,  \nVImbIWfxODVsiRHebSQePw",
    "1-0": "date_range_start",
    "1-1": "The first week of data you want.",
    "1-2": "2018-02-01",
    "2-0": "date_range_end",
    "2-1": "The last week of data you want",
    "2-2": "2018-03-01"
  },
  "cols": 3,
  "rows": 3,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]

# Sample Request

```text
GET https://api.yelp.com/v3/businesses/engagement?business_ids=nBvdJyM7TCHp5ppX31SC5Q,WoI1IisL_AgmWdiJLRb-Zw
```

# Sample Response

```text
{
  "data": [
    {
      "business_id": "nBvdJyM7TCHp5ppX31SC5Q",
      "metrics": [
        {
          "start_of_week_date": "2018-02-05",
          "engagement_metric": 20,
          "intent_metric": 10
        },
        {
          "start_of_week_date": "2018-02-12",
          "engagement_metric": 20,
          "intent_metric": 10
        }
      ]
    },
    {
      "business_id": "VImbIWfxODVsiRHebSQePw",
      "metrics": [
        {
          "start_of_week_date": "2018-02-05",
          "engagement_metric": 20,
          "intent_metric": 10
        },
        {
          "start_of_week_date": "2018-02-12",
          "engagement_metric": 20,
          "intent_metric": 10
        }
      ]
    }
  ]
}
```

# Response Attributes

[block:parameters]
{
  "data": {
    "h-0": "Name",
    "h-1": "Type",
    "h-2": "Description",
    "0-0": "business_id",
    "0-1": "string",
    "0-2": "Unique Yelp ID of the business.",
    "1-0": "metrics",
    "1-1": "object\\[]",
    "1-2": "List of metrics for the business in the specified week.",
    "2-0": "start_of_week_date",
    "2-1": "date",
    "2-2": "The first day of the week for the associated metrics.",
    "3-0": "engagement_metric",
    "3-1": "int",
    "3-2": "Amalgam of page views, website clicks, bookmarks, calls & messages to business, clicks on directions, reviews & photos posted, check-ins.  \nIndicative of consumer engagement relative to all other North America-based businesses on Yelp.  \nValues range from 1-20",
    "4-0": "intent_metric",
    "4-1": "int",
    "4-2": "Amalgam of all engagement attributes included in Consumer Engagement Metric except page views.  \nIndicative of consumer intent relative to all other North America-based businesses on Yelp.  \nValues range from 1-10."
  },
  "cols": 3,
  "rows": 5,
  "align": [
    "left",
    "left",
    "left"
  ]
}
[/block]