find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/yelp:yelp-monthly-reports-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Yelp Monthly Reports API
  version: '1.0'
  description: 'Operations tagged Monthly Reports across 2 of this provider''s published API definitions: yelp-reporting-api-v2-api-openapi.yml, yelp-reporting-api-v3-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://partner-api.yelp.com/analytics
- url: https://api.yelp.com/v3/reporting/
tags:
- name: Monthly Reports
paths:
  /v2/businesses/monthly_reports:
    post:
      deprecated: true
      summary: Request Monthly Report
      tags:
      - Monthly Reports
      description: Requests a report containing monthly business/advertiser metrics for a specified list of businesses over a date range. Monthly business metrics can be requested up to 2 months ago.
      operationId: create_monthly_reports_v2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                start:
                  type: string
                  pattern: \d{4}-\d{2}
                  description: Start month. (Format `YYYY-MM`)
                end:
                  type: string
                  pattern: \d{4}-\d{2}
                  description: End month. (Format `YYYY-MM`)
                ids:
                  $ref: '#/paths/~1v2~1businesses~1daily_reports/post/requestBody/content/application~1json/schema/properties/ids'
                metrics:
                  $ref: '#/paths/~1v2~1businesses~1daily_reports/post/requestBody/content/application~1json/schema/properties/metrics'
              required:
              - start
              - end
              - ids
              - metrics
            example:
              value:
                start: 2020-01
                end: 2020-02
                ids:
                - w-WAiKJe__oZV13M34pTFw
                - ThncHZzfDNaNYYMXk88hLQ
                metrics:
                - billed_clicks
                - billed_impressions
                - ad_cost
                - num_calls
                - num_total_page_views
                - num_directions_and_map_views
      responses:
        $ref: '#/paths/~1v2~1businesses~1daily_reports/post/responses'
      security:
      - basic: []
    servers:
    - url: https://partner-api.yelp.com/analytics
  /v2/businesses/monthly_reports/{report_id}:
    get:
      deprecated: true
      summary: Get Monthly Report
      tags:
      - Monthly Reports
      description: Fetches the monthly report associated with {report_id}.
      operationId: get_monthly_reports_v2
      parameters:
      - name: report_id
        in: path
        description: The Report ID from [create_monthly_reports_v2](https://docs.developer.yelp.com/reference/create_monthly_reports_v2).
        required: true
        schema:
          type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              schema:
                $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/200/content/application~1json/schema'
              examples:
                Result:
                  value:
                    errors:
                      inactive_ids: []
                      invalid_ids: []
                      unauthorized_ids: []
                    data:
                    - metrics:
                      - num_desktop_cta_clicks: 0
                        num_check_ins: 3
                        num_messages_to_business: 0
                        num_calls: 36
                        deals_sold: 0
                        num_mobile_search_appearances: 1857
                        programs:
                        - ad_cost:
                            currency: USD
                            cost: 30000
                          ad_driven_user_photos: 0
                          ad_driven_directions_and_map_views: 22
                          program_type: cpc
                          ad_driven_online_bookings: 0
                          ad_driven_cta_clicks: 12
                          ad_driven_check_ins: 1
                          ad_driven_bookmarks: 0
                          ad_driven_url_clicks: 18
                          ad_driven_messages_to_business: 0
                          program_id: ScBkQynxr-odpwI2DTg
                          campaign_id: YmQ7kLwS2vNp-bEf5GjU
                          campaign_name: Winter Ad Campaign
                          ad_driven_calls: 22
                          ad_driven_deals_sold: 0
                          billed_impressions: 20425
                          billed_clicks: 137
                        num_mobile_cta_clicks: 16
                        num_directions_and_map_views: 33
                        num_bookmarks: 0
                        tracking_calls: 0
                        date: 2019-02
                        online_orders: 0
                        url_clicks: 8
                        online_bookings: 0
                        num_total_page_views: 283
                        num_mobile_page_views: 261
                        num_page_views: 283
                        num_desktop_page_views: 22
                        num_desktop_search_appearances: 325
                        num_user_photos: 0
                      business_id: pd4KsaDOBCCMBKBJJw
                      store_code: XYZ789
                    report_id: 4b9f8dc6-3ab5-4d97-86e1-41caa3c
        '202':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/202'
        '400':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/400'
        '401':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/401'
        '403':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/403'
        '404':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/404'
        '413':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/413'
        '429':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/429'
        '500':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/500'
        '503':
          $ref: '#/paths/~1v2~1businesses~1daily_reports~1{report_id}/get/responses/503'
      security:
      - basic: []
    servers:
    - url: https://partner-api.yelp.com/analytics
  /businesses/monthly:
    post:
      summary: Request Monthly Report
      tags:
      - Monthly Reports
      description: 'Requests a report containing monthly business/advertiser metrics for a specified list of businesses over a date range. The start month can be up to 730 days (2 years) ago, and the date range cannot exceed 3 months.


        Use get_monthly_reports_v3 to poll for report completion and retrieve the report.'
      operationId: create_monthly_reports_v3
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                start:
                  type: string
                  pattern: \d{4}-\d{2}
                  description: Start month. (Format `YYYY-MM`)
                end:
                  type: string
                  pattern: \d{4}-\d{2}
                  description: End month. (Format `YYYY-MM`)
                ids:
                  $ref: '#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/ids'
                metrics:
                  $ref: '#/paths/~1businesses~1daily/post/requestBody/content/application~1json/schema/properties/metrics'
              required:
              - start
              - end
              - ids
              - metrics
            example:
              value:
                start: 2020-01
                end: 2020-02
                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:
                $ref: '#/paths/~1businesses~1daily/post/responses/202/content/application~1json/schema'
              examples:
                Report created successfully:
                  value:
                    id: f046a18a-4192-4600-b2df-52633e8f5
        '400':
          description: 'Bad Request. Message varies depending on failure scenario


            | code  | description |

            | ------------- | ------------- |

            | VALIDATION_ERROR  | Validation Error.  |

            | INVALID_REQUEST  | Invalid Request.  |

            | MAX_NUM_OF_DAILY_LOOKBACK_ERROR  | The number of days to look up monthly business metrics exceeded the maximum (730). Please use a start date less than 730 days from now  |

            | MAX_NUM_OF_MONTHS_RANGE_ERROR  | The date range for monthly business metrics exceeded the maximum (3 months). Please use a date range of less than 3 months  |

            | END_DATE_EARLIER_THAN_START_DATE  | The start date has to be earlier or equal to the end date.  |

            '
          content:
            application/json:
              schema:
                $ref: '#/paths/~1businesses~1daily/post/responses/400/content/application~1json/schema'
              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 monthly business metrics exceeded the maximum (730). Please use a start date less than 730 days from now
                MAX_NUM_OF_MONTHS_RANGE_ERROR:
                  value:
                    error:
                      code: MAX_NUM_OF_MONTHS_RANGE_ERROR
                      description: The date range for monthly business metrics exceeded the maximum (3 months). Please use a date range of less than 3 months
                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':
          $ref: '#/paths/~1businesses~1daily/post/responses/401'
        '403':
          $ref: '#/paths/~1businesses~1daily/post/responses/403'
        '413':
          $ref: '#/paths/~1businesses~1daily/post/responses/413'
        '429':
          $ref: '#/paths/~1businesses~1daily/post/responses/429'
        '500':
          $ref: '#/paths/~1businesses~1daily/post/responses/500'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.yelp.com/v3/reporting/
  /businesses/monthly/{report_id}:
    get:
      summary: Get Monthly Report
      tags:
      - Monthly Reports
      description: Fetch the monthly report associated with {report_id}.
      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'
      security:
      - bearerAuth: []
    servers:
    - url: https://api.yelp.com/v3/reporting/
components:
  securitySchemes:
    basic:
      type: http
      scheme: basic
    bearerAuth:
      type: http
      scheme: bearer
      description: 'To authenticate API calls with the API Key, set the Authorization HTTP header value as `Bearer API_KEY`.


        Example: `Bearer 23813239889e947efd3e787cc41b0b839f442a85c5bfd30bd4b9a85ec3a54d5cae4d52b37ff52e64deb9c83bd04883812a6cebde04f2f25752f31be0ac74b514`.


        You can create or find your API Key at [yelp.com](https://www.yelp.com/developers/v3/manage_app).

        '
x-refined-from:
- yelp-reporting-api-v2-api-openapi.yml
- yelp-reporting-api-v3-api-openapi.yml
x-generated-from: https://docs.developer.yelp.com/reference
x-generated-by: api-evangelist-pipeline-2026-06