> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Get reporting metadata

> Describes the reporting cubes, views, measures, dimensions, and segments available to query.

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

## Example

```ts automations/square-get-reporting-metadata.automation.ts theme={null}
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](https://developer.squareup.com/reference/square/reporting-api/get-reporting-metadata) 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.