Reporting fields

The following fields are supported in the generateReport field.

Resource attributes

Metrics

  • metric.adClickCount: The number of clicks on pins or search results. This metric is zero for TAKEOVER campaigns because they are displayed automatically without a click from the user. See this help center article for details.
  • metric.approxUniqueWazeDriversImpressionCount: The approximate number of unique impressions. When this metric is included in generateReport request, day must also be included and the only other permitted fields are those with the prefix metric.
  • metric.callAndUrlClickCount: The number of phone calls and website visits from the ad.
  • metric.costMicros: The cost accrued for the given row in micro currency units for the currency set on the account. For example, if the account currency is USD, then 1,000,000 is one US dollar. This metric includes capping, but not discounts.
  • metric.ctr: Click-through rate, metric.adClickCount/metric.impressionCount. 0 if metric.impressionCount is 0.
  • metric.deepLinkClickCount: the number of clicks on the deep link button from the location profile. The API doesn't allow you to create ads with deep links.
  • metric.engagementCount: The total number of interactions with the ad. This includes navigations, info button clicks, calls, and website visits for the row. See this help center article for details.
  • metric.favoriteBrandAddClickCount: The number of times a Waze driver has added the brand to their favorites.
  • metric.favoriteBrandRemoveClickCount: The number of times a Waze driver has removed the brand from their favorites.
  • metric.impressionCount: The number of impressions for the row.
  • metric.inboxClickCount: The number of times the main actions in inbox messages were clicked.
  • metric.inboxImpressionCount: The number of times inbox messages were viewed.
  • metric.inboxReminderClickCount: The number of times the main actions in inbox reminder messages were clicked.
  • metric.inboxReminderImpressionCount: The number of times inbox reminder messages were viewed.
  • metric.locationSaveClickCount: The number of times Waze drivers saved the location to their history list.
  • metric.moreInfoClickCount: The number of clicks on the info "i" button.
  • metric.navigationCount: The number of navigations for the row.
  • metric.navigationDirectCount: The number of navigations initiated directly from the ad and location profile.
  • metric.navigationHistoryCount: The number of navigations from a driver's history list. Locations are saved to the driver's history list when the driver navigates or chooses "save location."
  • metric.profileUriClickCount: The number of website visits from the location profile.

Device attributes

  • deviceOs: The operating system the Waze Driver uses. The following values are supported:
    • ANDROID includes both Android mobile phones and Android Auto
    • IOS includes both iPhone and CarPlay
    • UNKNOWN
  • deviceType: The type of device the Waze Driver uses. The following values are supported:
    • MOBILE_PHONE
    • IN_CAR this includes Android Auto, CarPlay and SmartDeviceLink. See this help center article for details of SmartDeviceLink.
    • UNKNOWN

Time groupings

The fields string can support at most one of the Time Grouping Fields date, week, month or year value.

  • date: The date that ads were shown to Waze drivers, in the format YYYY-MM-DD. The time zone of the location is used to determine this date.
  • week: The week that ads were shown to Waze drivers, in the format YYYY-MM-DD. Monday is the first date of the week, so 2020-02-24 represents the whole week from Monday 2020-02-24 to Sunday 2020-03-01 inclusive. The time zone of the location is used to determine the week.
  • month: The month that ads were shown to Waze drivers, in the format YYYY-MM-01. The time zone of the location is used to determine the month.
  • year: The year that ads were shown to Waze drivers, in the format YYYY-01-01. The time zone of the location is used to determine the year.