Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Analytics → Create Reports

AI-generated

Summary

Send a request to create an analytics report with specified metrics, dimensions, and optional filters.

Inputs

  • Metrics (required) — A JSON array specifying up to 10 types of data to include in the report.
  • Dimensions (required) — A JSON array specifying up to 10 dimensions to group the data by, with constraints allowing only one time-based and one location-based dimension per report.
  • Filters — A JSON object with optional filter criteria to refine the report data, including date ranges and other attributes.

Output shape

A JSON object representing the created analytics report as returned by the Yext Knowledge API.

The inputs Metrics, Dimensions, and Filters are parsed from JSON strings to JSON objects in the request body. Request options such as batching, proxy, timeout, and SSL handling can be configured as node credentials or settings but do not affect the output shape.

Discussion