Request Monthly Report

post

https://api.yelp.com/v3/reporting/businesses/monthly

Requests a report containing monthly business/advertiser metrics for a specified list of businesses over a date range. Monthly metrics can be requested up to 2 months ago.

Use get_monthly_reports_v3 to poll for report completion and retrieve the report.

📘
This endpoint is part of the Reporting API, visit Reporting API to learn more.

Responses

code	description
VALIDATION_ERROR	Validation Error.
INVALID_REQUEST	Invalid Request.
MAX_NUM_OF_DAILY_LOOKBACK_ERROR	The number of days to look up daily business metrics exceeded the maximum (89). Please use a start date less than 89 days from now
END_DATE_EARLIER_THAN_START_DATE	The start date has to be earlier or equal to the end date.

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.

Language

Credentials

Bearer

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

📘

202202 - Accepted

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.

403Partner API endpoints require set up by Yelp before they can be used. You are trying to access a Partner API endpoint for which your API Client has not been enabled. Please reach out to [email protected] for more information.

413The number of businesses in the request exceeded the maximum (500)

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