---
title: "View aggregated synced Yelp reporting metrics"
method: GET
path: "/app/yelp/reporting"
tags: ["App Yelp"]
---

# View aggregated synced Yelp reporting metrics

`GET /app/yelp/reporting`

## Request

- Base URL: `https://api.optimyzee.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.optimyzee.com/app/yelp/reporting`
- Auth: none declared
- TypeScript: <https://skmtc.dev/optimyzee/apis/optimyzee-api/docs/app/yelp/reporting/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `businessId` string
- `from` string, date
- `to` string, date

## Response `200`

OK

- AppYelpReportingSchema
  - `kpis` AppYelpReportingKpiSchema, required
    - `totalSpendCents` integer
    - `totalLeads` integer
    - `costPerLeadCents` integer
    - `ctr` number, float
    - `avgCpcCents` integer
    - `billableClicks` integer
    - `billableImpressions` integer
    - `calls` integer
    - `raqMessages` integer
    - `websiteClicks` integer
    - `pageViews` integer
  - `leadBreakdown` AppYelpReportingLeadBreakdownSliceSchema[], required
    - `label` string
    - `value` integer
  - `daily` AppYelpReportingDailyPointSchema[], required
    - `date` string
    - `spendCents` integer
    - `leads` integer
    - `billableClicks` integer
    - `billableImpressions` integer
    - `calls` integer
    - `raqMessages` integer
    - `websiteClicks` integer
    - `pageViews` integer
  - `businesses` AppYelpReportingBusinessMetricSchema[], required
    - `businessRef` string
    - `businessName` string
    - `rating` number, float, nullable
    - `reviewCount` integer, nullable
    - `pageViews` integer
    - `websiteClicks` integer
    - `calls` integer
    - `raqMessages` integer
    - `billableImpressions` integer
    - `billableClicks` integer
    - `spendCents` integer
  - `leadLocations` AppYelpReportingLeadLocationsSchema, required: Leads grouped by the customer's ZIP from the Yelp request payload (lead.project.location.postal_code). `items` holds the top ZIPs only; `total` counts every lead in the window and `unknown` those without a ZIP.
    - `total` integer, required
    - `unknown` integer, required
    - `items` AppYelpReportingLeadLocationSchema[], required
      - `postalCode` string
      - `leads` integer

---

[API](https://skmtc.dev/optimyzee/apis/optimyzee-api.md) - [All operations](https://skmtc.dev/optimyzee/apis/optimyzee-api/llms.txt) - [OpenAPI document](https://skmtc.dev/optimyzee/apis/optimyzee-api/revisions/ccaa14692e9f?raw)