Get Lead Metrics

get

https://api.yelp.com/v3/leads/{ID}/metrics

Returns the metrics belonging to a given Lead ID.

Example

To fetch the metrics belonging to a lead with the ID "jPlz8TM628rzyCRPqrtcvm", send an authenticated GET request to the following URL:

https://api.yelp.com/v3/leads/jPlz8TM628rzyCRPqrtcvm/metrics

For the above request, a successful GET call would return the lead metrics if they exist in our system.
A sample response is shown in the example response box on the right under "200 - Metrics"

API Responses

{ "metrics": { "cost_per_lead": { "value": 0, "currency_code": "USD" } } }

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

code	description
UNAUTHORIZED_API_KEY	The API key provided is not currently able to query this endpoint.
TOKEN_INVALID	Invalid API key or authorization header.

code	description
UNAUTHORIZED_BUSINESS_MINIMUM_ADVERTISING	"You're not authorized to access this business as it does not meet minimum advertising requirements."
NO_BUSINESS_ACCESS	"You don't have access to this Business."

200Metrics of the lead.

400The provided ID is not recognized as a valid Yelp Lead ID

401The API key has either expired or doesn't have the required scopes to query this endpoint. codedescriptionUNAUTHORIZED_API_KEYThe API key provided is not currently able to query this endpoint.TOKEN_INVALIDInvalid API key or authorization header.

404The Lead with the given ID was not found.

429You have either exceeded your daily quota, or have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries.

500Internal Server Error