--- agentTools: projectIndex: https://docs.developer.yelp.com/llms.txt --- # Get Monthly Report Fetch the monthly report associated with {report_id}. [block:callout] { "type": "info", "body": "This endpoint is part of the Reporting API, visit [Reporting API](https://docs.developer.yelp.com/docs/reporting-api) to learn more." } [/block] # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Reporting API V3", "version": "1.0" }, "servers": [ { "url": "https://api.yelp.com/v3/reporting/" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "To authenticate API calls with the API Key, set the Authorization HTTP header value as `Bearer API_KEY`.\n\nExample: `Bearer 23813239889e947efd3e787cc41b0b839f442a85c5bfd30bd4b9a85ec3a54d5cae4d52b37ff52e64deb9c83bd04883812a6cebde04f2f25752f31be0ac74b514`.\n\nYou can create or find your API Key at [yelp.com](https://www.yelp.com/developers/v3/manage_app).\n" } } }, "security": [ { "bearerAuth": [] } ], "paths": { "/businesses/daily": { "post": { "summary": "Request Daily Report", "tags": [ "Daily Reports" ], "description": "Requests a report containing daily business/advertiser metrics for a specified list of businesses over a date range. The start date can be up to 730 days (2 years) ago, and the date range (end minus start) cannot exceed 89 days.\n\nUse [get_daily_reports_v3](https://docs.developer.yelp.com/reference/get_daily_reports_v3) to poll for report completion and retrieve the report.\n", "operationId": "create_daily_reports_v3", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "start": { "type": "string", "format": "date", "description": "Start date. (Format `YYYY-MM-dd`)" }, "end": { "type": "string", "format": "date", "description": "End date. (Format `YYYY-MM-dd`)" }, "ids": { "description": "A list of Yelp Business IDs", "type": "array", "items": { "type": "string", "description": "Yelp Encrypted Business ID." } }, "metrics": { "description": "Business and Advertising Metrics to be included in report.\n See [Business Metrics](https://docs.developer.yelp.com/docs/reporting-api#business-metrics) and [Advertiser Metrics](https://docs.developer.yelp.com/docs/reporting-api#advertiser-metrics) for a detailed description of all available metrics.\n", "type": "array", "items": { "description": "Business and Advertising Metric name.", "type": "string", "enum": [ "num_total_page_views", "num_calls", "num_directions_and_map_views", "url_clicks", "num_check_ins", "num_user_photos", "num_bookmarks", "num_desktop_cta_clicks", "num_mobile_cta_clicks", "num_messages_to_business", "num_mobile_page_views", "num_desktop_search_appearances", "num_mobile_search_appearances", "num_desktop_page_views", "tracking_calls", "deals_sold", "online_orders", "online_bookings", "check_in_offer_redemptions", "collection_item_added", "rapc_initiated", "waitlist_visit_created", "median_response_time_in_sec", "reply_rate", "organic_biz_page_views", "organic_biz_page_views_percentage", "rating", "reviews", "total_leads", "billed_impressions", "billed_clicks", "ad_cost", "ad_driven_bookmarks", "ad_driven_calls", "ad_driven_cta_clicks", "ad_driven_check_ins", "ad_driven_deals_sold", "ad_driven_directions_and_map_views", "ad_driven_messages_to_business", "ad_driven_user_photos", "ad_driven_online_reservations", "ad_driven_url_clicks", "ad_click_through_rate", "average_cost_per_click", "billable_ad_clicks", "billable_ad_impressions", "ad_driven_biz_page_views", "ad_driven_calls_tracked", "ad_driven_rapc_initiated", "ad_driven_waitlist_visit_created", "ad_driven_total_leads", "ad_driven_platform_purchase_made", "ad_driven_biz_page_views_percentage" ] } } }, "required": [ "start", "end", "ids", "metrics" ] }, "example": { "value": { "start": "2020-01-01", "end": "2020-02-28", "ids": [ "w-WAiKJe__oZV13M34pTFw", "ThncHZzfDNaNYYMXk88hLQ" ], "metrics": [ "billed_clicks", "billed_impressions", "ad_cost", "num_calls", "num_total_page_views", "num_directions_and_map_views" ] } } } } }, "responses": { "202": { "description": "202 - Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "description": "ID of the report.", "type": "string" } }, "required": [ "id" ] }, "examples": { "Report created successfully": { "value": { "id": "f046a18a-4192-4600-b2df-52633e8f5" } } } } } }, "400": { "description": "Bad Request. Message varies depending on failure scenario\n\n| code | description |\n| ------------- | ------------- |\n| VALIDATION_ERROR | Validation Error. |\n| INVALID_REQUEST | Invalid Request. |\n| MAX_NUM_OF_DAILY_LOOKBACK_ERROR | The number of days to look up daily business metrics exceeded the maximum (730). Please use a start date less than 730 days from now |\n| MAX_NUM_OF_DAILY_RANGE_ERROR | The date range for daily business metrics exceeded the maximum (89 days). Please use a date range of less than 89 days |\n| END_DATE_EARLIER_THAN_START_DATE | The start date has to be earlier or equal to the end date. |\n", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "description": "The error code, something like `VALIDATION_ERROR` or `INVALID_REQUEST`", "type": "string" }, "description": { "description": "The error description, some error codes may have multiple description describing in detail what went wrong.", "type": "string" }, "field": { "description": "In case of VALIDATION_ERROR's this field may be present and may contain the field that failed validation.", "type": "string", "x-nullable": true }, "instance": { "description": "In case of VALIDATION_ERROR's this field may be present and may contain the instance that failed validation.", "type": "string", "x-nullable": true } } } } }, "examples": { "INVALID_REQUEST": { "value": { "error": { "code": "INVALID_REQUEST", "description": "Invalid Request" } } }, "MAX_NUM_OF_DAILY_LOOKBACK_ERROR": { "value": { "error": { "code": "MAX_NUM_OF_DAILY_LOOKBACK_ERROR", "description": "The number of days to look up daily business metrics exceeded the maximum (730). Please use a start date less than 730 days from now" } } }, "MAX_NUM_OF_DAILY_RANGE_ERROR": { "value": { "error": { "code": "MAX_NUM_OF_DAILY_RANGE_ERROR", "description": "The date range for daily business metrics exceeded the maximum (89 days). Please use a date range of less than 89 days" } } }, "END_DATE_EARLIER_THAN_START_DATE": { "value": { "error": { "code": "END_DATE_EARLIER_THAN_START_DATE", "description": "The start date has to be earlier or equal to the end date." } } } } } } }, "401": { "description": "The API key has either expired or doesn't have the required scopes to query this endpoint.\n\n| code | description |\n| ------------- | ------------- |\n| UNAUTHORIZED_API_KEY | The API key provided is not currently able to query this endpoint. |\n| TOKEN_INVALID | Invalid API key or authorization header. |\n", "content": { "application/json": { "examples": { "Unauthorized": { "value": { "error": { "code": "UNAUTHORIZED_API_KEY", "description": "The API key provided is not currently able to query this endpoint." } } }, "Invalid Token": { "value": { "error": { "code": "TOKEN_INVALID", "description": "Invalid API key or authorization header." } } } }, "schema": { "type": "object", "properties": { "error": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "type": "string", "description": "The error code." }, "description": { "type": "string", "description": "The description of the error." } } } } } } } }, "403": { "description": "Partner 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 partner-support@yelp.com for more information.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/401/content/application~1json/schema" }, "examples": { "Endpoint Disabled": { "value": { "error": { "code": "PARTNER_ENDPOINT_DISABLED", "description": "You are trying to access a Partner API endpoint for which your API Client has not been enabled. Please reach out to partner-support@yelp.com for more information." } } } } } } }, "413": { "description": "The number of businesses in the request exceeded the maximum (500)", "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "description" ], "properties": { "code": { "description": "The error code, something like `VALIDATION_ERROR` or `INVALID_REQUEST`", "type": "string" }, "description": { "description": "The error description, some error codes may have multiple description describing in detail what went wrong.", "type": "string" } } } } }, "examples": { "NUMBER_OF_BUSINESS_LIMIT_ERROR": { "value": { "error": { "code": "NUMBER_OF_BUSINESS_LIMIT_ERROR", "description": "The number of businesses in the request exceeded the maximum (500)" } } } } } } }, "429": { "description": "You 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.", "content": { "application/json": { "examples": { "Rate limited": { "value": { "error": { "code": "TOO_MANY_REQUESTS_PER_SECOND", "description": "You have exceeded the queries-per-second limit for this endpoint. Try reducing the rate at which you make queries." } } } }, "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/401/content/application~1json/schema" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "examples": { "Internal Server Error": { "value": { "error": { "code": "INTERNAL_ERROR", "description": "Something went wrong internally, please try again later." } } } }, "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/401/content/application~1json/schema" } } } } } } }, "/businesses/daily/{report_id}": { "get": { "summary": "Get Daily Report", "tags": [ "Daily Reports" ], "description": "Fetch the daily report associated with {report_id}.\n", "operationId": "get_daily_reports_v3", "parameters": [ { "name": "report_id", "in": "path", "description": "The Report ID from [create_daily_reports_v3](https://docs.developer.yelp.com/reference/create_daily_reports_v3).", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Report generated successfully.", "content": { "application/json": { "schema": { "type": "object", "required": [ "report_id", "data" ], "properties": { "report_id": { "type": "string" }, "data": { "type": "array", "description": "A list of businesses each with the requested metrics.", "items": { "type": "object", "required": [ "business_id", "metrics" ], "properties": { "business_id": { "$ref": "#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/ids/items" }, "store_code": { "type": "string", "x-nullable": true, "description": "The store code associated with the business, if available." }, "metrics": { "type": "array", "description": "Business and Advertising metrics for a specific business and a specific date (daily reports) or month (monthly reports).", "items": { "type": "object", "required": [ "date" ], "properties": { "date": { "type": "string", "pattern": "\\d{4}-\\d{2}(-\\d{2})?", "description": "Either YYYY-MM-DD or YYYY-MM depending on whether retrieving a monthly or daily report." }, "num_total_page_views": { "type": "integer", "description": "Queryable metric: Number of total page views on desktop and mobile devices." }, "num_calls": { "type": "integer", "description": "Queryable metric: Number of phone calls initiated from the Yelp business profile." }, "num_directions_and_map_views": { "type": "integer", "description": "Queryable metric: Number of direction and map views from the Yelp business profile." }, "url_clicks": { "type": "integer", "description": "Queryable metric: Number of clicks to the business URL from the Yelp business profile." }, "num_check_ins": { "type": "integer", "description": "Queryable metric: Number of mobile check-ins from the Yelp business profile." }, "num_user_photos": { "type": "integer", "description": "Queryable metric: Number of user generated photos added to the Yelp business profile." }, "num_bookmarks": { "type": "integer", "description": "Queryable metric: Number of times a business has been bookmarked by users." }, "num_desktop_cta_clicks": { "type": "integer", "description": "Queryable metric: Number of Call-to-Action clicks on desktop devices." }, "num_mobile_cta_clicks": { "type": "integer", "description": "Queryable metric: Number of Call-to-Action clicks on mobile devices." }, "num_messages_to_business": { "type": "integer", "description": "Queryable metric: Number of messages sent to a business, including messages sent through Request a Quote." }, "num_mobile_page_views": { "type": "integer", "description": "Queryable metric: Number of page views on mobile devices." }, "num_desktop_search_appearances": { "type": "integer", "description": "Queryable metric: Number of times a business appeared in search on desktop devices." }, "num_mobile_search_appearances": { "type": "integer", "description": "Queryable metric: Number of times a business appeared in search on mobile devices." }, "num_desktop_page_views": { "type": "integer", "description": "Queryable metric: Number of page views on desktop devices." }, "tracking_calls": { "type": "integer", "description": "Queryable metric: Number of calls tracked." }, "deals_sold": { "type": "integer", "description": "Queryable metric: Number of deals sold." }, "online_orders": { "type": "integer", "description": "Queryable metric: Number of online orders." }, "online_bookings": { "type": "integer", "description": "Queryable metric: Number of online bookings" }, "check_in_offer_redemptions": { "type": "number", "format": "float", "description": "The number of users that redeemed a check in offer for your listing (if applicable)." }, "collection_item_added": { "type": "number", "format": "float", "description": "The number of time your business was added to a collection other than the default bookmark collection." }, "rapc_initiated": { "type": "number", "format": "float", "description": "Number of times RaPC was initiated." }, "waitlist_visit_created": { "type": "number", "format": "float", "description": "Number of times someone got in line on the Yelp Waitlist." }, "median_response_time_in_sec": { "type": "number", "format": "float", "description": "The median time it took for your business to answer messages." }, "reply_rate": { "type": "number", "format": "float", "description": "The percentage of messages replied." }, "organic_biz_page_views": { "type": "number", "format": "float", "description": "The amount of organic page views of your listing, which were not occurring as a consequence of ad clicks and ad impressions." }, "organic_biz_page_views_percentage": { "type": "number", "format": "float", "description": "It measures which percentage of biz page views didn't derive from ads." }, "rating": { "type": "number", "format": "float", "description": "Average Rating (1-5 star scale)." }, "reviews": { "type": "number", "format": "float", "description": "The number of unfiltered reviews of your listing." }, "total_leads": { "type": "number", "format": "float", "description": "Total # of leads (sums all Leads metrics)." }, "programs": { "type": "array", "description": "Ad Metrics are reported per Ad program.", "items": { "type": "object", "required": [ "program_type", "program_id" ], "properties": { "program_type": { "type": "string", "x-nullable": true, "description": "This is the type of ad program the metrics are for." }, "program_id": { "type": "string", "description": "Yelp program ID" }, "campaign_id": { "type": "string", "x-nullable": true, "description": "The campaign ID associated with the program, if one is linked." }, "campaign_name": { "type": "string", "x-nullable": true, "description": "The name of the campaign associated with the program, if one is linked." }, "billed_impressions": { "type": "integer", "description": "Queryable metric: Number of times Ad is displayed and will be billed." }, "billed_clicks": { "type": "integer", "description": "Queryable metric: Number of clicks from a billed impression." }, "ad_cost": { "type": "object", "description": "Cost of Ad when billed (in cents).", "required": [ "currency", "cost" ], "properties": { "currency": { "type": "string", "description": "[ISO 4217 Currency Code](https://en.wikipedia.org/wiki/ISO_4217)" }, "cost": { "type": "integer", "description": "In cents of `currency`." } } }, "ad_driven_bookmarks": { "type": "integer", "description": "Queryable metric: Number of times a business has been bookmarked by users that can be attributed to an Ad impression." }, "ad_driven_calls": { "type": "integer", "description": "Queryable metric: Number of phone calls initiated from the Yelp business profile that can be attributed to an Ad impression." }, "ad_driven_cta_clicks": { "type": "integer", "description": "Queryable metric: Number of Call-to-Action clicks on desktop devices that can be attributed to an Ad impression." }, "ad_driven_check_ins": { "type": "integer", "description": "Queryable metric: Number of mobile check-ins from the Yelp business profile that can be attributed to an Ad impression." }, "ad_driven_deals_sold": { "type": "integer", "description": "Queryable metric: Number of deals sold that can be attributed to an Ad impression." }, "ad_driven_directions_and_map_views": { "type": "integer", "description": "Queryable metric: Number of direction and map views from the Yelp business profile that can be attributed to an Ad impression." }, "ad_driven_messages_to_business": { "type": "integer", "description": "Queryable metric: Number of messages sent to a business, including messages sent through Request a Quote that can be attributed to an Ad impression" }, "ad_driven_user_photos": { "type": "integer", "description": "Queryable metric: Number of user generated photos added to the Yelp business profile that can be attributed to an Ad impression." }, "ad_driven_online_reservations": { "type": "integer", "description": "Queryable metric: Number of Yelp Reservations and Yelp Nowait bookings through Yelp that can be attributed to an Ad impression." }, "ad_driven_url_clicks": { "type": "integer", "description": "Queryable metric: Number of clicks to the business URL from the Yelp business profile that can be attributed to an Ad impression." }, "ad_click_through_rate": { "type": "number", "format": "float", "description": "Ad CTR measures how well Yelp performs at getting users to click on your ads." }, "average_cost_per_click": { "type": "number", "format": "float", "description": "This metric measures, on average, the amount of cost per billable clicks that Yelp attributed to your Yelp business pages for all clicks-based ad campaigns (if applicable)." }, "billable_ad_clicks": { "type": "integer", "description": "The number of times a user clicked on a search advertisement for your listing and came to its Yelp business page across all platforms." }, "billable_ad_impressions": { "type": "integer", "description": "The number of times your listing was displayed in an advertisement." }, "ad_driven_biz_page_views": { "type": "integer", "description": "Ad Driven Yelp page visits is a measure of how many times your Yelp page was accessed or viewed on the Yelp website, mobile website, and mobile apps after seeing or clicking on an ad. This amount of pages visits is calculated using our 30 days attribution logic for ad clicks and 1 day for ad impressions." }, "ad_driven_calls_tracked": { "type": "integer", "description": "The number of calls made by Yelp users after seeing or clicking on your ad which were successfully answered by your business, when you're using Yelp's Call Reporting feature." }, "ad_driven_rapc_initiated": { "type": "integer", "description": "Number of times RaPC was initiated after seeing or clicking an ad." }, "ad_driven_waitlist_visit_created": { "type": "integer", "description": "Number of times someone got in line on the Yelp Waitlist after seeing or clicking an ad." }, "ad_driven_total_leads": { "type": "integer", "description": "Total # of ad driven leads (sums all AdDrivenLeads metrics)." }, "ad_driven_platform_purchase_made": { "type": "integer", "description": "Number of platform purchases that were to be fulfilled by third parties (GrubHub for food ordering, GoldStar for tickets etc.) and are attributed to an ad." }, "ad_driven_biz_page_views_percent": { "type": "number", "format": "float", "description": "It measures which percentage of biz page views derived from ads." } } } } } } } } } }, "errors": { "type": "object", "description": "Requested Business IDs for which metrics could not be loaded are listed here.", "required": [ "inactive_ids", "unauthorized_ids", "invalid_ids" ], "properties": { "inactive_ids": { "description": "List of supplied Business IDs for which no data was contained because these businesses are inactive.", "$ref": "#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/ids" }, "unauthorized_ids": { "description": "List of supplied Business IDs for which no data was contained because the client is currently not authorized to view theses businesses' metrics.", "$ref": "#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/ids" }, "invalid_ids": { "description": "List of supplied Business IDs for which no data was contained because they are not valid Yelp Business IDs.", "$ref": "#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/ids" } } } } }, "examples": { "Result": { "value": { "errors": { "inactive_ids": [], "invalid_ids": [], "unauthorized_ids": [] }, "data": [ { "metrics": [ { "num_desktop_cta_clicks": 0, "num_check_ins": 0, "num_messages_to_business": 0, "num_page_views": 4, "deals_sold": 0, "num_mobile_search_appearances": 37, "num_bookmarks": 0, "programs": [ { "ad_cost": { "currency": "USD", "cost": 571 }, "ad_driven_user_photos": 0, "ad_driven_directions_and_map_views": 0, "program_type": "cpc", "ad_driven_online_bookings": 0, "ad_driven_cta_clicks": 0, "ad_driven_check_ins": 0, "ad_driven_bookmarks": 0, "program_id": "ScBkQyG5Cnxr-odI2DTg", "campaign_id": "XkP9mNvR3wLq-aCd4FhT", "campaign_name": "Summer Ad Campaign", "ad_driven_messages_to_business": 0, "ad_driven_url_clicks": 0, "ad_driven_calls": 0, "ad_driven_deals_sold": 0, "billed_impressions": 258, "billed_clicks": 3 } ], "num_directions_and_map_views": 0, "num_mobile_cta_clicks": 0, "tracking_calls": 0, "date": "2019-01-28", "online_orders": 0, "url_clicks": 0, "online_bookings": 0, "num_total_page_views": 4, "num_mobile_page_views": 3, "num_calls": 0, "num_desktop_page_views": 1, "num_desktop_search_appearances": 8, "num_user_photos": 0 }, { "num_desktop_cta_clicks": 0, "num_check_ins": 0, "num_messages_to_business": 0, "num_page_views": 8, "deals_sold": 0, "num_mobile_search_appearances": 46, "num_bookmarks": 0, "programs": [ { "ad_cost": { "currency": "USD", "cost": 591 }, "ad_driven_user_photos": 0, "ad_driven_directions_and_map_views": 0, "program_type": "cpc", "ad_driven_online_bookings": 0, "ad_driven_cta_clicks": 0, "ad_driven_check_ins": 0, "ad_driven_bookmarks": 0, "program_id": "ScBkQyG5Cnxr-odpwITg", "campaign_id": "XkP9mNvR3wLq-aCd4FhT", "campaign_name": "Summer Ad Campaign", "ad_driven_messages_to_business": 0, "ad_driven_url_clicks": 1, "ad_driven_calls": 0, "ad_driven_deals_sold": 0, "billed_impressions": 493, "billed_clicks": 4 } ], "num_directions_and_map_views": 0, "num_mobile_cta_clicks": 0, "tracking_calls": 0, "date": "2019-01-29", "online_orders": 0, "url_clicks": 1, "online_bookings": 0, "num_total_page_views": 8, "num_mobile_page_views": 7, "num_calls": 0, "num_desktop_page_views": 1, "num_desktop_search_appearances": 11, "num_user_photos": 0 }, { "num_desktop_cta_clicks": 0, "num_check_ins": 0, "num_messages_to_business": 0, "num_page_views": 8, "deals_sold": 0, "num_mobile_search_appearances": 45, "num_bookmarks": 0, "programs": [ { "ad_cost": { "currency": "USD", "cost": 401 }, "ad_driven_user_photos": 0, "ad_driven_directions_and_map_views": 1, "program_type": "cpc", "ad_driven_online_bookings": 0, "ad_driven_cta_clicks": 0, "ad_driven_check_ins": 0, "ad_driven_bookmarks": 0, "program_id": "ScBkQyG5Cnxr-odI2DTg", "campaign_id": "XkP9mNvR3wLq-aCd4FhT", "campaign_name": "Summer Ad Campaign", "ad_driven_messages_to_business": 0, "ad_driven_url_clicks": 1, "ad_driven_calls": 0, "ad_driven_deals_sold": 0, "billed_impressions": 851, "billed_clicks": 4 } ], "num_directions_and_map_views": 1, "num_mobile_cta_clicks": 0, "tracking_calls": 0, "date": "2019-01-30", "online_orders": 0, "url_clicks": 3, "online_bookings": 0, "num_total_page_views": 8, "num_mobile_page_views": 7, "num_calls": 1, "num_desktop_page_views": 1, "num_desktop_search_appearances": 16, "num_user_photos": 0 }, { "num_desktop_cta_clicks": 0, "num_check_ins": 0, "num_messages_to_business": 0, "num_page_views": 7, "deals_sold": 0, "num_mobile_search_appearances": 44, "num_bookmarks": 0, "programs": [ { "ad_cost": { "currency": "None", "cost": 0 }, "ad_driven_user_photos": 0, "ad_driven_directions_and_map_views": 0, "program_type": "cpc", "ad_driven_online_bookings": 0, "ad_driven_cta_clicks": 0, "ad_driven_check_ins": 0, "ad_driven_bookmarks": 0, "program_id": "ScBkQyG5Cnxr-odpwDTg", "campaign_id": null, "campaign_name": null, "ad_driven_messages_to_business": 0, "ad_driven_url_clicks": 0, "ad_driven_calls": 0, "ad_driven_deals_sold": 0, "billed_impressions": 20, "billed_clicks": 0 } ], "num_directions_and_map_views": 1, "num_mobile_cta_clicks": 0, "tracking_calls": 0, "date": "2019-01-31", "online_orders": 0, "url_clicks": 0, "online_bookings": 0, "num_total_page_views": 7, "num_mobile_page_views": 3, "num_calls": 0, "num_desktop_page_views": 4, "num_desktop_search_appearances": 15, "num_user_photos": 0 }, { "num_desktop_cta_clicks": 0, "num_check_ins": 0, "num_messages_to_business": 0, "num_page_views": 15, "deals_sold": 0, "num_mobile_search_appearances": 76, "num_bookmarks": 0, "programs": [ { "ad_cost": { "currency": "USD", "cost": 1253 }, "ad_driven_user_photos": 0, "ad_driven_directions_and_map_views": 0, "program_type": "cpc", "ad_driven_online_bookings": 0, "ad_driven_cta_clicks": 2, "ad_driven_check_ins": 0, "ad_driven_bookmarks": 0, "program_id": "ScBkQyG5Cnxr-odI2DTg", "campaign_id": "XkP9mNvR3wLq-aCd4FhT", "campaign_name": "Summer Ad Campaign", "ad_driven_messages_to_business": 0, "ad_driven_url_clicks": 0, "ad_driven_calls": 1, "ad_driven_deals_sold": 0, "billed_impressions": 578, "billed_clicks": 7 } ], "num_directions_and_map_views": 0, "num_mobile_cta_clicks": 1, "tracking_calls": 0, "date": "2019-02-01", "online_orders": 0, "url_clicks": 0, "online_bookings": 0, "num_total_page_views": 15, "num_mobile_page_views": 14, "num_calls": 1, "num_desktop_page_views": 1, "num_desktop_search_appearances": 25, "num_user_photos": 0 } ], "business_id": "pd4KsaDOBCCMBGEaJJw", "store_code": "ABC123" } ], "report_id": "f046a18a-4192-4600-b2df-52633e8f5" } } } } } }, "202": { "description": "The requested report job is not complete yet or the report failed.\n\n| code | description |\n| ------------- | ------------- |\n| JOB_NOT_COMPLETE | Job Not Complete. |\n| JOB_FAILED | Job Failed. Please note that if a job failed because of authorization issues, the endpoint will raise a 403 - Forbidden with the code AUTHORIZATION_ERROR |\n", "content": { "application/json": { "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/413/content/application~1json/schema" }, "examples": { "JOB_NOT_COMPLETE": { "value": { "error": { "code": "JOB_NOT_COMPLETE", "description": "Job Not Complete" } } }, "JOB_FAILED": { "value": { "error": { "code": "JOB_FAILED", "description": "Job Failed" } } } } } } }, "400": { "description": "Bad Request. Message varies depending on failure scenario\n\n| code | description |\n| ------------- | ------------- |\n| VALIDATION_ERROR | Validation Error. |\n| INVALID_REPORT_ID | Invalid Request |\n| REPORT_GRANULARITY_ERROR | Invalid report granularity requested. Attempted to retrieve a monthly report, on a daily endpoint. Please request the report on a monthly endpoint. |\n", "content": { "application/json": { "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/400/content/application~1json/schema" }, "examples": { "INVALID_REPORT_ID": { "value": { "error": { "code": "INVALID_REPORT_ID", "description": "Invalid Request" } } }, "REPORT_GRANULARITY_ERROR": { "value": { "error": { "code": "REPORT_GRANULARITY_ERROR", "description": "Invalid report granularity requested. Attempted to retrieve a monthly report, on a daily endpoint. Please request the report on a monthly endpoint." } } } } } } }, "401": { "$ref": "#/paths/~1businesses~1daily/post/responses/401" }, "403": { "description": "Authorization Error or Partner API endpoint disabled.", "content": { "application/json": { "schema": { "$ref": "#/paths/~1businesses~1daily/post/responses/401/content/application~1json/schema" }, "examples": { "Authorization Error": { "value": { "error": { "code": "AUTHORIZATION_ERROR", "description": "Authorization Error" } } }, "Endpoint Disabled": { "value": { "error": { "code": "PARTNER_ENDPOINT_DISABLED", "description": "You are trying to access a Partner API endpoint for which your API Client has not been enabled. Please reach out to partner-support@yelp.com for more information." } } } } } } }, "429": { "$ref": "#/paths/~1businesses~1daily/post/responses/429" }, "500": { "$ref": "#/paths/~1businesses~1daily/post/responses/500" } } } }, "/businesses/monthly/{report_id}": { "get": { "summary": "Get Monthly Report", "tags": [ "Monthly Reports" ], "description": "Fetch the monthly report associated with {report_id}.\n", "operationId": "get_monthly_reports_v3", "parameters": [ { "name": "report_id", "in": "path", "description": "The Report ID from [create_monthly_reports_v3](https://docs.developer.yelp.com/reference/create_monthly_reports_v3).", "required": true, "schema": { "type": "string" } } ], "responses": { "$ref": "#/paths/~1businesses~1daily~1{report_id}/get/responses" } } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": false, "samples-enabled": true }, "_id": { "buffer": { "0": 99, "1": 54, "2": 230, "3": 71, "4": 95, "5": 26, "6": 132, "7": 0, "8": 29, "9": 86, "10": 152, "11": 234 } } } ```