Get reporting metadata - Automate.ax

square.getReportingMetadata describes the reporting cubes, views, measures, dimensions, and segments available to query.

Example

automations/square-get-reporting-metadata.automation.ts

import { automation, onDashboardRun } from "automate.ax"
import { square } from "automate.ax/square"

export default automation("Get Square reporting metadata", () => {
  onDashboardRun({ title: "Get Square reporting metadata" })

  square.getReportingMetadata()
})

Inputs

Every input accepts a compatible signal. It requires REPORTING_READ. This action has no inputs. Use the official GetReportingMetadata reference for provider field semantics and limits.

Output

Returns the official Square.MetadataResponse response as a codec-safe object. Square integer money amounts remain bigint values.